Here are all the comments that your Udacity Code Reviewer had about your code...

Size: px

Start display at page:

Download "Here are all the comments that your Udacity Code Reviewer had about your code..."

Heather Booker
5 years ago
Views:

1 Here are all the comments that your Udacity Code Reviewer had about your code... Line 4 in udacity_portfolio_project.py is Critical file_p=raw_input("pleaseenterthenetworklocationoftheportfolio file:") #locationoffileonnetwork Reviewer says: If you assume that the.csv file will always reside in the same directory as the project file itself and will always have a fixed name, it would be more convenient to use the os module to get the current working directory and then open the file. This way you won't have to ask the user for the file's path (which can be irritating for the user; and not to mention very error prone :P). Here's how the code would look: os.path.dirname(os.path.realpath( file ) Here, file refers to the current.py file. You can read more here: current directory and files directory However, if your program requires the user to provide the path of the.csv file, you should add some exception handling for erroneous inputs. Currently, if the user provides a wrong path, the program throws an error and the user has to rerun the program. Users will mess up the path often (the first time, I did too _ ) and you don't want your program to break every time that happens. So if a user submits a wrong path, your program should prompt the user and ask for the path again. You can read more here:

2 user input error handling Line 5 in udacity_portfolio_project.py is Nitpick port=open(file_p,"r") #opensfile Reviewer says: There's nothing wrong in the way you've written this. However, it may interest you to know a slightly more pythonic way of opening a file by using the 'with' keyword :D Using the with statement ensures that the opened file is closed before the Python program finishes execution. Example: with open('portfolio.csv', 'r') as port: reader = csv.reader(port, delimiter = ',') More information on this here: is the python keyword with used for Line 207 in udacity_portfolio_project.py is Awesome whileindustrycountryorcompanynotinaccepted: industrycountryorcompany=int(raw_input("wouldyou liketosummarizebycompany,industry,orcountry?(1=company,2= Industry,3=Country):")) Reviewer says: This is a good way of handling erroneous inputs from users. They can make the same mistake repeatedly without breaking the program. Very slick :) Line 257 in udacity_portfolio_project.py is Critical print"whenpromptedbytheprogram,typethethree lettercountryabbreviationinuppercaseintotheprompt.otherwise,to lookupacountry'sinfo,type-countryanalysis(\"countrythreeletter ABBREVIATION\")-makesuretheCountryNameisinuppercase.Ifnodata isreturned,thentherearenoloansoutstandingtothatcountry.please keepinmindthatyoumustinputthethreeletterabbreviationofthe

3 name!" Reviewer says: This line right here (including the indentation) is 437 character long (x_x). I had to scroll a lot horizontally to read it on a 13inch Mac. There are several other lines in the program where the line length exceeds way beyond characters. Google's Style Guide recommends max line length to be 80 characters. It's common amongst programmers, to set a maximum line length at 80 or 120 characters. You should consider doing so too. It will improve the readability of your code :) You can find the styleguide here: styleguide.googlecode.com/svn/trunk/pyguide.html Line 20 in udacity_portfolio_project.py is Nitpick fori_dini_id_invalid_list: foriinrange(len(i_id_invalid_list)): delportlist[i_d-i] Reviewer says: It's awesome that you've written a function that cleans invalid data. This way you're taking care of possible errors before hand :) However, these nested loops in this function look complicated and you could probably use comments here to make sure others reading this (or you reading it after very long) don't find it very hard to understand :? I tried printing the variables out to understand what the ranges of the loops meant and what data this function gets rid of, but the portfolio.csv file that you've provided along with the project does not have any invalid data to be deleted (by this function). Line 245 in udacity_portfolio_project.py is Nitpick print Reviewer says: A blank print statement hanging all by itself is a little unusual :?. I could see it in several places in the code. It's a lot more common to use '\n' within strings to print a line break in Python.

4 You probably already know this, and chose to use 'print' by itself for some reason. If not, you'll find more information here: Line 151 in udacity_portfolio_project.py is Awesome c_exp=sum([float(portlist[i][norm])foriin range(1,len(portlist))ifportlist[i][summed]== self.name]) Reviewer says: Good use of the sum function on a list comprehension to perform calculations. Very succinct :) Line 283 in udacity_portfolio_project.py is Critical fileopen=open("monthlyportfoliosummary.csv",'wb') portfoliofile=csv.writer(fileopen,dialect="excel", quotechar='"') portfoliofile.writerow(["month","exposure","capital","pd","lgd","rsq"]) portfoliofile.writerow([" ",sum_norm(),sum_capital(),wa_pd(),wa_lgd,wa_rsq()]) fileopen.close() else: Reviewer says: After creating the.csv file and closing it (with fileopen.close()), the program doesn't give any success message to the user. This will probably leave the user in doubt as to whether the file has been created or not. I myself got a bit confused and had to see the project's directory to find the.csv file there. You should probably leave a message like this after creating the file.csv for the user: The requested.csv file has been successfully created. You can find it in the folder that's enclosing this program. Line 307 in udacity_portfolio_project.py is Critical ecce,help=portfolioanalysisstart()

5 Reviewer says: The word 'help' is a reserved word in Python and it's considered bad practice to use a language's reserved words or keywords as a variable name. If you use a text editor with syntax highlighting, the word 'help' would appear colored in a.py file. This way you can avoid using any such word as a variable name. You should probably use a variable name like: need_help You can read Google's Python styleguide to see what they have to say about consistent variable names and class names: styleguide.googlecode.com/svn/trunk/pyguide.html You can check out this multi platform text editor with syntax highlighting: Line 248 in udacity_portfolio_project.py is Nitpick filetypeval=int(raw_input("wouldyouliketocreateamontlyportfolio summarizationfile?(1=yes,2=no):")) iffiletypeval==1: fileopen=open("monthlyportfoliosummary.csv",'wb') portfoliofile=csv.writer(fileopen,dialect="excel", quotechar='"') portfoliofile.writerow(["month","exposure","capital","pd","lgd","rsq"]) portfoliofile.writerow([" ",sum_norm(),sum_capital(),wa_pd(),wa_lgd,wa_rsq()]) fileopen.close() else: Reviewer says: Here, your code first asks the user to input either 1 (for yes) and 2 (for no). However, it executes the 'no' option if the user's input is not 1 (using else). This is alright and it works, but users may find it misleading if they submit another number (or letter) by mistake. Instead, your code should throw this question back at them if they give an input different from the ones your program expects. This way you can make sure your program doesn't do anything its user doesn't want it to. A similar problem exists in the function portfolioanalysisstart(). The raw_inputs expect

6 either a 1 or a 2, but the program proceeds indifferently for any number the user submits.

A PROGRAM IS A SEQUENCE of instructions that a computer can execute to

A PROGRAM IS A SEQUENCE of instructions that a computer can execute to perform some task. A simple enough idea, but for the computer to make any use of the instructions, they must be written in a form