问题:
当对函数传递形参时,或者函数返回值是某个对象时,直接使用发现无法自动补全其自己携带的方法,这样会非常降低开发效率
eg:
def get_verify_code(self, session):# 这个session是一个对象,当在函数中使用的时候,无法自动补全其携带的方法 2 """ 3 4 :param session: 传递进来session对象 5 :return: 返回的是响应response 6 """ 7 return session.get(self.verify_url) 8 9 def test01_logoin(self): 10 response = self.login_api.get_verify_code() 11 self.assertEqual("image/png", response.headers)# 这种情况就不会补全,我们获取了上一个函数的返回值,返回值是一个response对象,但是pycharm无法识别 12 self.assertEqual(200, response.status_code)
解决办法一:
直接上图:----用添加type hints(类型提示)来解决
那么上段代码添加类型提示的步骤如下:
def get_verify_code(self, session):# 1、将光标放在session处 2、点击Alt+Enter 3、选择specify type for the reference using annotation ... 4、按Enter后输入类型 2 """ 3 4 :param session: 传递进来session对象 5 :return: 返回的是响应response 6 """ 7 return session.get(self.verify_url) 8 9 def test01_logoin(self): 10 response = self.login_api.get_verify_code()#1、将光标放在此处 2、点击Alt+Enter 3、选择Add hint for... 4、按Enter后输入类型
# 给函数的返回值添加类型提示时 会自动跳转到原函数进行添加
self.assertEqual("image/png", response.headers) 12 self.assertEqual(200, response.status_code)
eg:添加类型提示后的代码如下:
1 def get_verify_code(self, session: requests.Session) -> requests.Response: # 这样代码就可以自动补全了,调用其返回函数就可以补全 2 """ 3 :param session: 传递进来session对象 4 :return: 返回的是响应response 5 """ 6 return session.get(self.verify_url) 7 8 def test01_logoin(self): 9 response = self.login_api.get_verify_code() 10 self.assertEqual("image/png", response.headers) 11 self.assertEqual(200, response.status_code)
解决办法二(推荐):
在函数的注释中给形参添加类型提示
1 def get_verify_code(self, session) -> requests.Response: 2 """ 3 类型提示 可以让其自动补全 4 :type session: requests.Session 5 :param session: 传递进来session对象 6 :return: 返回的是响应response 7 """ 8 return session.get(self.verify_url)
解决办法三:
直接在后面添加 类型提示也是可以的但是没有上面的方法快捷,只需在原函数添加一次,以后每次调用都可以补全
1 def get_verify_code(self, session: requests.Session): # 这样代码就可以自动补全了,调用其返回函数就可以补全 2 2 """ 3 3 :param session: 传递进来session对象 4 4 :return: 返回的是响应response 5 5 """ 6 6 return session.get(self.verify_url) 7 7 8 8 def test01_logoin(self): 9 9 response = self.login_api.get_verify_code() #type: requests.Response 10 10 self.assertEqual("image/png", response.headers) 11 11 self.assertEqual(200, response.status_code)
请参考python中文网的type hints 类型提示解析:
https://www.pycharm.net.cn/docs/302.html