--- a/src/eric7/WebBrowser/Passwords/PasswordManager.py Fri Dec 22 13:57:47 2023 +0100
+++ b/src/eric7/WebBrowser/Passwords/PasswordManager.py Fri Dec 22 17:24:07 2023 +0100
@@ -45,7 +45,8 @@
"""
Constructor
- @param parent reference to the parent object (QObject)
+ @param parent reference to the parent object
+ @type QObject
"""
super().__init__(parent)
@@ -86,9 +87,12 @@
"""
Public method to get the login credentials.
- @param url URL to get the credentials for (QUrl)
- @param realm realm to get the credentials for (string)
- @return tuple containing the user name (string) and password (string)
+ @param url URL to get the credentials for
+ @type QUrl
+ @param realm realm to get the credentials for
+ @type str
+ @return tuple containing the user name (string) and password
+ @rtype str
"""
if not self.__loaded:
self.__load()
@@ -105,10 +109,14 @@
"""
Public method to set the login credentials.
- @param url URL to set the credentials for (QUrl)
- @param realm realm to set the credentials for (string)
- @param username username for the login (string)
- @param password password for the login (string)
+ @param url URL to set the credentials for
+ @type QUrl
+ @param realm realm to set the credentials for
+ @type str
+ @param username username for the login
+ @type str
+ @param password password for the login
+ @type str
"""
if not self.__loaded:
self.__load()
@@ -124,9 +132,12 @@
"""
Private method to create the key string for the login credentials.
- @param url URL to get the credentials for (QUrl)
- @param realm realm to get the credentials for (string)
- @return key string (string)
+ @param url URL to get the credentials for
+ @type QUrl
+ @param realm realm to get the credentials for
+ @type str
+ @return key string
+ @rtype str
"""
authority = url.authority()
if authority.startswith("@"):
@@ -142,7 +153,8 @@
"""
Public method to get the file name of the passwords file.
- @return name of the passwords file (string)
+ @return name of the passwords file
+ @rtype str
"""
return os.path.join(Globals.getConfigDir(), "web_browser", "logins.xml")
@@ -218,7 +230,8 @@
"""
Public method to remove a password entry.
- @param site web site name (string)
+ @param site web site name
+ @type str
"""
if site in self.__logins:
del self.__logins[site]
@@ -230,7 +243,8 @@
"""
Public method to get a list of all site names.
- @return sorted list of all site names (list of strings)
+ @return sorted list of all site names
+ @rtype list of str
"""
if not self.__loaded:
self.__load()
@@ -241,7 +255,8 @@
"""
Public method to get the number of available sites.
- @return number of sites (integer)
+ @return number of sites
+ @rtype int
"""
if not self.__loaded:
self.__load()
@@ -252,8 +267,10 @@
"""
Public method to get a reference to the named site.
- @param site web site name (string)
- @return tuple containing the user name (string) and password (string)
+ @param site web site name
+ @type str
+ @return tuple containing the user name (string) and password
+ @rtype str
"""
if not self.__loaded:
self.__load()
@@ -339,8 +356,10 @@
"""
Private method to strip off all unneeded parts of a URL.
- @param url URL to be stripped (QUrl)
- @return stripped URL (QUrl)
+ @param url URL to be stripped
+ @type QUrl
+ @return stripped URL
+ @rtype QUrl
"""
cleanUrl = QUrl(url)
cleanUrl.setQuery("")
@@ -359,7 +378,8 @@
"""
Public slot to complete login forms with saved data.
- @param page reference to the web page (WebBrowserPage)
+ @param page reference to the web page
+ @type WebBrowserPage
"""
if page is None:
return
@@ -387,8 +407,10 @@
"""
Public slot to handle the change of the main password.
- @param oldPassword current main password (string)
- @param newPassword new main password (string)
+ @param oldPassword current main password
+ @type str
+ @param newPassword new main password
+ @type str
"""
if not self.__loaded:
self.__load()
