Israel Fruchter: KISS - Keep it shorter short

Today on work on a python related mailing list someone sent this snippet of code he didn’t wrote. and that was causing some of the server he worte/manged some troubles.

Here’s the code:

defdeploy_file(full_path_to_file,full_path_in_server):iffull_path_to_fileisNoneorfull_path_in_serverisNoneorfull_path_to_file==""orfull_path_in_server=="":print_error_exit(" wrong input for deploy_file")try:post_status=Nonewithopen(full_path_to_file,mode="rb")asf:print("Deploying...:  %s"%full_path_in_server)file_content=f.read()post_status=requests.put(url=full_path_in_server,data=file_content)ifpost_status.status_code==200orpost_status.status_code==201orpost_status.status_code==202:print("Success:  %s"%full_path_in_server)return{"uploaded":file_to_upload}else:print_error_exit("Deployment to %s failed. status_code = %s, returned_text = %s"%(full_path_in_server,post_status.status_code,post_status.text))exceptExceptionasex:print(ex)print_error_exit("Posting with url %s failed. status: %s"%(full_path_in_server,post_status))

First thought I hade was, the one wrote it is must be coming from C (or maybe Java), so let go over what’s wrong here.

1. Input validation

   I don’t know what’s print_error_exit() is doing exactly, let’s assume it’s raising expection (hopefully it’s not calling os.exit())
   So assertion with the proper text would be alsmot identical.

   Checking both for None, and for empty string is futile, just assert, like this:

assertfull_path_to_file,"parameter can't be empty"assertfull_path_in_server,"parameter can't be empty"

1. Using requests to stream file

   Requests is cool, alsmot the defacto standard when HTTP client is need in python. it has very good documention, clearly someone didn’t read it.streaming uploads

2. Multiple error paths

   Lot of different error handling code, one for checking the http statuses and one for catching expections.

My version

defdeploy_file(full_path_to_file,full_path_in_server):assertfull_path_to_file,"parameter can't be empty"assertfull_path_in_server,"parameter can't be empty"res=Nonetry:withopen(full_path_to_file,mode="rb")asf:logging.info("Deploying...:  %s",full_path_in_server)res=requests.put(url=full_path_in_server,data=f)assertres.status_codein[200,201,202]logging.info("Success:  %s",full_path_in_server)return{"uploaded":file_to_upload}exceptExceptionasex:logging.expection("deploy_file faild")# so we'll have a nice print in the log# casue I don't know what print_error_exit() does, we'll call it.# even that I would prefer to just raise the expection up, i.e. "raise ex"print_error_exit("Deployment to %s failed. status_code = %s, returned_text = %s"%(full_path_in_server,res.status_codeifreselseNone,res.textifreselseNone))