[[Category:OPS435-Python]][[Category:rchanebrauer]]= Overview : du Improved =When making back up of data files or log files, it <code>du</code> is a very common practice to name the backup tool for inspecting directories and/or files based on the date the backup was done. In order to restore or locate It will return the contents of a directory/along with how much drive space they are using. However, it can be parse its output quickly, as it usually returns file, we often need to find out the backup date from today's date.sizes as a number of bytes:
The computational task for this assignment is to design an algorithm and write <code><b>user@host ~ $ du --max-depth 1 /usr/local/lib</b></code><pre>164028 /usr/local/lib/heroku11072 /usr/local/lib/python2.792608 /usr/local/lib/node_modules8 /usr/local/lib/python3.8267720 /usr/local/lib</pre>You will therefore be creating a python script according to your algorithm with appropriate functionstool called <b>duim (du improved></b>. The Your script should take two dates in will call du and return the "DD-MM-YYYY" format contents of a specified directory, and return generate a bar graph for each subdirectory. The bar graph will represent the number drive space as percent of days from the first to total drive space for the second datespecified directory. That An example of the finished code your script might produce is, if the this: <code><b>user enters "18-06-2020" and "25-06-2020", the script will return "@host ~ $ ./duim.py /usr/local/lib</b></code><pre> 61 % [============ ] 160.2 MiB /usr/local/lib/heroku 4 % [= ] 10.8 MiB /usr/local/lib/python2.7" 34 % [======= ] 90.4 MiB /usr/local/lib/node_modules 0 % [ ] 8.0 kiB /usr/local/lib/python3. Similarly, if the target date is in the past, the script will return a negative number8Total: 261.4 MiB /usr/local/lib</pre>
In addition, if The details of the user enters one date onlyfinal output will be up to you, then the number returned should but you will be the number of days between today's date and the specified daterequired to fulfill some specific requirements before completing your script. Read on...
= Assignment Requirements =
== The First Milestone (due June 19) Permitted Modules ==* 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 <b><font color='blue''algorithm_[student_id].txt'''. This file should be plaintext. The document will contain two sections: * A description of how the "after()" function works. The "after()" function >Your python script is provided allowed to you in a1_template.py. Open import only the file<u>os, subprocess 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. * 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 sys</u> modules from the function itself. * This file will be submitted to Blackboard a week after the assignment goes live, and should be your first prioritystandard library. 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.* [https:</font></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.* 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.)b>
== The Assignment (due July 3) Required Functions ==* As stated before, your code You will be need to complete the functions inside the provided file "a1_[studentid]called <code>duim.py"</code>. The first step provided <code>checkA1.py</code> will be used to clone test these functions. * <code>call_du_sub()</code> should take the target directory as an argument and return a list of strings returned by the Assignment command <b>du -d 1 repository<target directory></b>.** Use subprocess.Popen. ** '-d 1' specifies a <i>max depth</i> of 1. Your list shouldn't include files, just a list of subdirectories in the target directory.** Your list should <u>not</u> contain newline characters. * <code>percent_to_graph()</code> should take two arguments: percent and the total chars. It should return a 'bar graph' as a string. The invite link ** Your function should check that the percent argument is a valid number between 0 and 100. It should fail if it isn't. You can <code>raise ValueError</code> in this case.** <b>total chars</b> refers to the total number of characters that the bar graph will be provided to composed of. You can use equal signs <code>=</code> or any other character that makes sense, but the empty space <b>must be composed of spaces</b>, at least until you have passed the first milestone.** The string returned by this function should only be composed of these two characters. For example, calling <code>percent_to_graph(50, 10)</code> should return: '===== '* <code>create_dir_dict</code> should take a list as the argument, and should return a dictionary.** The list can be the list returned by your professor<code>call_du_sub()</code>. Once ** The dictionary that you clone return should have the full directory name as <i>key</i>, and the number of bytes in the directory as the <i>value</i>. This value should be an integer. For example, using the example of <b>/usr/local/lib</b>, the repositoryfunction would return: {'/usr/local/lib/heroku': 164028, run this command'/usr/local/lib/python2.7': "cp a1_template11072, ...py a1_[studentid]} == Additional Functions ==You may create any other functions that you think appropriate, especially when you begin to build additional functionality.pyPart of your evaluation will be on how "re-usable"your functions are, and sensible use of arguments and return values. (Replace studentid with == Use of GitHub ==You will be graded partly on the quality of your Github commits. You may make as many commits as you wish, it will have no impact on your myseneca username)grade. Begin writing the content that The only exception to this is required<b>assignments with very few commits.</b> These will receive low marks for GitHub use and may be flagged for possible academic integrity violations. Additional <b><font color='blue'>Assignments that do not adhere to these requirements are outlined belowmay not be accepted.</font></b> Professionals generally follow these guidelines:* commit their code after every significant change, * the code <i>should hopefully</i> run without errors after each commit, and* every commit has a descriptive commit message.
== The Debrief (due July 10) ==This documentAfter completing each function, like the algorithm document, will be submitted to Blackboard one week after the assignment. Answer the following questions:* Research Python modules that you could have used to accomplish the same goals as the today() and leap_year() functions. * Which solution is preferable, in terms of performance? Which solution is preferable, in terms of programmer hours? (which solution would take longer for make a programmer to implement?)* 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, commit 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 push your submission. You should answer these questions as wellcode.
== Assignment Requirements ===== Required Modules and Functions ===<b><font color='blue'>Your python script is allowed to import only the <u>osAfter fixing a problem, subprocess and sys</u> modules from the standard library make a commit and all the built-in functionspush your code.</font></b>
Based on the algorithm you have designed for this assignment, you should at least have the following four functions defined in <b><u>GitHub is your python script (see later section on the purpose backup and your proof of each function) in order to get a passing grade for this assignment:* dbda()* after()* before()* today()work.</u></b>
You should also create additional functions 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 improved the re-usability of solve each small problem. Test your python code by adding the following functions to earn the maximum possible mark for this assignment:* days_in_mon()* leap_year()* valid_date()* usage()after each small change you make, and address errors as soon as they arise. It will make your life easier!
=== Coding Standard ===
Your python script must follow the following coding guide:
* [https://www.python.org/dev/peps/pep-0008/ PEP-8 -- Style Guide for writing Python Code]
=== Command Line Argument to be supported ===
* You will provided with a file called a1_template.py.
* Rename this python script as a1_[student_id].py, where [student_id] is your Seneca email user name.
* Your python script must support one or two command line arguments only: both should be valid dates in DD-MM-YYYY format.
* If there are no arguments, more than two arguments, or an invalid date, your script should display the correct usage message and exit.
=== 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.
* Your script should also include in-line comments to explain anything that isn't immediately obvious to a beginner programmer. <b><u>It is expected that you will be able to explain how each part of your code works in detail.</u></b>
* Refer to the docstring for after() to get an idea of the function docstrings required.
=== Authorship Declaration ===
All your Python code for this assignment must be placed in a the provided Python file called <font color='red'b>assignment1.py</b>. <u>single source python Do not change the name of this file.</u></b></font>. Please complete the declaration <b><u>as part of the docstring</u></b> in your Python source code file (replace "Student Name" with your own name). = Submission Guidelines and Process = == Clone Your Repo (ASAP) == The first step will be to clone the Assignment 1 repository. The invite link will be provided to you by your professor. The repo will contain a check script, a README file, and the file where you will enter your code. == The First Milestone (due February 14) ==For the first milestone you will have two functions to complete.* <code>call_du_sub</code> will take one argument and return a list. The argument is a target directory. The function will use <code>subprocess.Popen</code> to run the command <b>du -d l <target_directory></b>. * <code>percent_to_graph</code> will take two arguments and return a string.
=== Github Commits === You will be graded partly on In order to complete <code>percent_to_graph()</code>, it's helpful to know the quality of your Github commitsequation for converting a number from one scale to another. Professionals generally follow these guidelines [[File:Scaling-formula.png]] * commit their code after every significant changeIn this equation, * ``x`` refers to your input value percent and ``y`` will refer to the code should run without errors after each commit, number of symbols to print. The max of percent is 100 and* every commit has a descriptive commit messagethe min of percent is 0.These guidelines Be sure that you are not always possible, but you will be expected rounding to follow these guidelines as much as possible. Break your problem into smaller piecesan integer, and work iteratively then print that number of symbols to solve each small problemrepresent the percentage. Test your code after each small change The number of spaces that you make, and address errors as soon as they ariseprint will be the inverse. It will make your life easier!
== 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:* <b><code>python3 a1_rchan.py 01-01-2019 02-01-2019</code></b>, and the output should be<br /> 1* <b><code>python3 a1_rchan.py 01-01-2019 31-12-2018</code></b>, and the output should be<br /> -1* <b><code>python3 a1_rchan.py 01-06-2020</code></b>, and since today is June 3, functions with the output should be<br /> 2 * <b><code>python3 a1_rchan.py 01-01-2019 01-01-2020</code></b>, and the output should be<br /> 365* <b><code>python3 a1_rchanPython interpreter.py 01-01-2021 01-01-2020 </code></b>, and the output should be<br /> -366* <b>Use <code>python3 a1_rchan.py 01-13-2018</code></b>, and the output should be<br /> Errorthen: wrong month entered* <b><code>python3 a1_rchan.py 99-01-2020 01-01-2020</code></b>, and the output should be<br /> Error: wrong day entered import duim* <b><code>python3 a1_rchan duim.py 2018 2</code></b>percent_to_graph(50, and the output should be<br /> Error: wrong date entered10)
If there is too few or too many command line arguments givenTo test with the check script, display run the proper usage:* <code>Usagefollowing: a1_rchan.py DD-MM-YYYY [DD-MM-YYYY] >/code>
== Script structure and sample template ==<code>python3 checkA1.py -f -v TestPercent</code>
The following is == Second Milestone (due February 21) ==For the second milestone you will have one more function to complete.* <code>create_dir_dict</code> will take your list from <code>call_du_sub</code> and return a dictionary. ** Every item in your list should create a key in your dictionary.** Your dictionary values should be a brief description number of each function:bytes.
* The dbda() function should be the main function of your script. The dbda() function will take two dates in "DD-MM-YYYY" format, and return an integer that corresponds to the number of days between the given dates. If the start date is earlier than the stop date, the number is positive. If start date is later than the stop date, the number is negative. 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 computerFor example: <code>{'s /usr/lib/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 "DD-MM-YYYY" format and return the date of the previous day in the same format.* The after() function will take a date in "DD-MM-YYYY" format and return the date of the next day in the same format. Next paragraph is a sample python 33400}</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 valid_date() function will take a date in "DD-MM-YYYY" 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 days_in_mon() function will take a year in "YYYY" formatAgain, 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 usage() function will take no argument and return a string describing the usage of test using your Python interpreter or the check script.
=== Sample code for To run the after() function ===<pre># Return check script, enter the date in DD-MM-YYYY after the given day# def after(today): if len(today) != 10: return '00-00-0000' elsefollowing: str_day, str_month, str_year = 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<code>python checkA1.py -f -v TestDirDict</code>
lyear = year % 100= Minimum Viable Product == Once you have achieved the Milestones, you will have to do the following to get a minimum viable product: * In your <code>if lyear __name__ == 0'__main__'</code> block, you will have to check command line arguments. ** If the user has entered no command line argument, use the current directory.** If the user has entered more than one argument, or their argument isn't a valid directory, print an error message.** Otherwise, the argument will be your target directory.* Call <code>call_du_sub</code> with the target directory.* Pass the return value from that function to <code>create_dir_dict</code>* You may wish to create one or more functions to do the following: feb_max = 28 # this is ** Use the total size of the target directory to calculate percentage.** For each subdirectory of target directory, you will need to calculate a percentage, using the total of the target directory.** Once you've calculated percentage, call <code>percent_to_graph</code> with a max_size of your choice. ** For every subdirectory, print <i>at least</i> the percent, the bar graph, and the name of the subdirectory.** The target directory <b>should not </b> have a leap yearbar graph.
lyear = year % 400 if lyear =Additional Features = 0: feb_max = 29 # this is a leap year
tmp_day = day + 1 # next dayAfter completing the above, you are expected to add some additional features. Some improvements you could make are:
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}* Format the output in a way that is easy to read. if tmp_day > mon_max[month]:* Add colour to the output. to_day = tmp_day % mon_max[month] # if tmp_day > this month's max* Add more error checking, reset print a usage message to 1the user. tmp_month = month + 1 else* Convert bytes to a human-readable format. NOTE:This doesn't have to be 100% accurate to get marks. to_day = tmp_day* Accept more options from the user. tmp_month = month + 0* Sort the output by percentage, or by filename.
if tmp_month > 12It is expected that the additional features you provided should be useful, non-trivial, they should not require super-user privileges and should not require the installation of additional packages to work. (ie: to_month = 1 year = year + 1 else: to_month = tmp_month + 0I shouldn't have to run pip to make your assignment work).
next_date = str= The Assignment (to_day)+"-"+str(to_monthdue March 7, 11:59pm)==* Be sure to make your final commit before the deadline.* Then, copy the contents of your <b>duim.py</b> file into a Word document, and submit it to Blackboard.zfill(2)+"-"+str(year)<i>I will use GitHub to evaluate your deadline, but submitting to Blackboard tells me that you wish to be evaluated.zfill(2) return next_date</prei>
= Rubric =
| Program Authorship Declaration || 5 ||
|-
| Check script passed required functions design || 30 5 ||
|-
| today() function design required functions readability || 2 5 ||
|-
| before() function main loop design || 5 10 ||
|-
| dbda() function design main loop readability || 10 ||
|-
| script level docstring output function design || 5 ||
|-
| leap_year() output function design readability || 2 5 ||
|-
| valid_date() function design additional features implemented || 5 20 ||
|-
| usage() function design docstrings and comments || 1 5 ||
|-
| First Milestone ||10||
|-
| Reflection Essay Second Milestone || 10 ||
|-
| github.com repository: Commit messages and use ||1510 ||
|-
|'''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_username.txt', to Blackboard.* [ ] your python script, named as 'a1_[seneca-id]duim.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.* [ ] your debrief document should be submitted to Blackboardby March 7 at 11:59pm.
