streamlit-authenticator API Reference
Full documentation for streamlit-authenticator (Standard Library / Native)
streamlit-authenticator.Authenticate
Python Library Documentation: class Authenticate in module streamlit_authenticator.views.authentication_view
class Authenticate(builtins.object)
| Authenticate(credentials: Union[Dict[str, Any], str], cookie_name: str = 'some_cookie_name', cookie_key: str = 'some_key', cookie_expiry_days: float = 30.0, validator: Optional[streamlit_authenticator.utilities.validator.Validator] = None, auto_hash: bool = True, api_key: Optional[str] = None, **kwargs: Optional[Dict[str, Any]]) -> None
|
| This class renders login, logout, register user, reset password, forgot password,
| forgot username, and modify user details widgets.
|
| Methods defined here:
|
| __init__(self, credentials: Union[Dict[str, Any], str], cookie_name: str = 'some_cookie_name', cookie_key: str = 'some_key', cookie_expiry_days: float = 30.0, validator: Optional[streamlit_authenticator.utilities.validator.Validator] = None, auto_hash: bool = True, api_key: Optional[str] = None, **kwargs: Optional[Dict[str, Any]]) -> None
| Initializes an instance of Authenticate.
|
| Parameters
| ----------
| credentials : dict or str
| Dictionary of user credentials or path to a configuration file.
| cookie_name : str, default='some_cookie_name'
| Name of the re-authentication cookie stored in the client's browser.
| cookie_key : str, default='some_key'
| Secret key used for encrypting the re-authentication cookie.
| cookie_expiry_days : float, default=30.0
| Expiry time for the re-authentication cookie in days.
| validator : Validator, optional
| Validator object for checking username, name, and email validity.
| auto_hash : bool, default=True
| If True, passwords will be automatically hashed.
| api_key : str, optional
| API key for sending password reset and authentication emails.
| **kwargs : dict, optional
| Additional keyword arguments.
|
| experimental_guest_login(self, button_name: str = 'Guest login', location: Literal['main', 'sidebar'] = 'main', provider: Literal['google', 'microsoft'] = 'google', oauth2: Optional[Dict[str, Any]] = None, max_concurrent_users: Optional[int] = None, single_session: bool = False, roles: Optional[List[str]] = None, use_container_width: bool = False, callback: Optional[Callable] = None) -> None
| Renders a guest login button.
|
| Parameters
| ----------
| button_name : str, default='Guest login'
| Display name for the guest login button.
| location : {'main', 'sidebar'}, default='main'
| Location where the guest login button is rendered.
| provider : {'google', 'microsoft'}, default='google'
| OAuth2 provider used for authentication.
| oauth2 : dict, optional
| Configuration parameters for OAuth2 authentication.
| max_concurrent_users : int, optional
| Maximum number of users allowed to log in concurrently.
| single_session : bool, default=False
| If True, prevents users from logging into multiple sessions simultaneously.
| roles : list of str, optional
| Roles assigned to guest users.
| use_container_width : bool, default=False
| If True, the button width matches the container.
| callback : Callable, optional
| Function to execute when the button is pressed.
|
| forgot_password(self, location: Literal['main', 'sidebar'] = 'main', fields: Optional[Dict[str, str]] = None, captcha: bool = False, send_email: bool = False, two_factor_auth: bool = False, clear_on_submit: bool = False, key: str = 'Forgot password', callback: Optional[Callable] = None) -> Tuple[Optional[str], Optional[str], Optional[str]]
| Renders a forgot password widget.
|
| Parameters
| ----------
| location : {'main', 'sidebar'}, default='main'
| Location of the forgot password widget.
| fields : dict, optional
| Custom labels for form fields and buttons.
| captcha : bool, default=False
| If True, requires captcha validation.
| send_email : bool, default=False
| If True, sends the new password to the user's email.
| two_factor_auth : bool, default=False
| If True, enables two-factor authentication.
| clear_on_submit : bool, default=False
| If True, clears input fields after form submission.
| key : str, default='Forgot password'
| Unique key for the widget to prevent duplicate WidgetID errors.
| callback : Callable, optional
| Function to be executed after form submission.
|
| Returns
| -------
| tuple[str, str, str] or (None, None, None)
| - Username associated with the forgotten password.
| - Email associated with the forgotten password.
| - New plain-text password to be securely transferred to the user.
|
| forgot_username(self, location: Literal['main', 'sidebar'] = 'main', fields: Optional[Dict[str, str]] = None, captcha: bool = False, send_email: bool = False, two_factor_auth: bool = False, clear_on_submit: bool = False, key: str = 'Forgot username', callback: Optional[Callable] = None) -> Tuple[Optional[str], Optional[str]]
| Renders a forgot username widget.
|
| Parameters
| ----------
| location : {'main', 'sidebar'}, default='main'
| Location of the forgot username widget.
| fields : dict, optional
| Custom labels for form fields and buttons.
| captcha : bool, default=False
| If True, requires captcha validation.
| send_email : bool, default=False
| If True, sends the retrieved username to the user's email.
| two_factor_auth : bool, default=False
| If True, enables two-factor authentication.
| clear_on_submit : bool, default=False
| If True, clears input fields after form submission.
| key : str, default='Forgot username'
| Unique key for the widget to prevent duplicate WidgetID errors.
| callback : Callable, optional
| Function to be executed after form submission.
|
| Returns
| -------
| tuple[str, str] or (None, str)
| - Username associated with the forgotten username.
| - Email associated with the forgotten username.
|
| login(self, location: Literal['main', 'sidebar', 'unrendered'] = 'main', max_concurrent_users: Optional[int] = None, max_login_attempts: Optional[int] = None, fields: Optional[Dict[str, str]] = None, captcha: bool = False, single_session: bool = False, clear_on_submit: bool = False, key: str = 'Login', callback: Optional[Callable] = None) -> Optional[Tuple[Optional[str], Optional[bool], Optional[str]]]
| Renders a login widget.
|
| Parameters
| ----------
| location : {'main', 'sidebar', 'unrendered'}, default='main'
| Location where the login widget is rendered.
| max_concurrent_users : int, optional
| Maximum number of users allowed to log in concurrently.
| max_login_attempts : int, optional
| Maximum number of failed login attempts allowed.
| fields : dict, optional
| Custom labels for form fields and buttons.
| captcha : bool, default=False
| If True, requires captcha validation.
| single_session : bool, default=False
| If True, prevents users from logging into multiple sessions simultaneously.
| clear_on_submit : bool, default=False
| If True, clears input fields after form submission.
| key : str, default='Login'
| Unique key for the widget to prevent duplicate WidgetID errors.
| callback : Callable, optional
| Function to execute when the form is submitted.
|
| Returns
| -------
| tuple[str, bool, str] or None
| - If `location='unrendered'`, returns (user's name, authentication status, username).
| - Otherwise, returns None.
|
| logout(self, button_name: str = 'Logout', location: Literal['main', 'sidebar', 'unrendered'] = 'main', key: str = 'Logout', use_container_width: bool = False, callback: Optional[Callable] = None) -> None
| Renders a logout button.
|
| Parameters
| ----------
| button_name : str, default='Logout'
| Display name for the logout button.
| location : {'main', 'sidebar', 'unrendered'}, default='main'
| Location where the logout button is rendered.
| key : str, default='Logout'
| Unique key for the widget, useful in multi-page applications.
| use_container_width : bool, default=False
| If True, the button width matches the container.
| callback : Callable, optional
| Function to execute when the button is pressed.
|
| register_user(self, location: Literal['main', 'sidebar'] = 'main', pre_authorized: Optional[List[str]] = None, domains: Optional[List[str]] = None, fields: Optional[Dict[str, str]] = None, captcha: bool = True, roles: Optional[List[str]] = None, merge_username_email: bool = False, password_hint: bool = True, two_factor_auth: bool = False, clear_on_submit: bool = False, key: str = 'Register user', callback: Optional[Callable] = None) -> Tuple[Optional[str], Optional[str], Optional[str]]
| Renders a register new user widget.
|
| Parameters
| ----------
| location : {'main', 'sidebar'}, default='main'
| Location where the registration widget is rendered.
| pre_authorized : list of str, optional
| List of emails of unregistered users who are authorized to register.
| domains : list of str, optional
| List of allowed email domains (e.g., ['gmail.com', 'yahoo.com']).
| fields : dict, optional
| Custom labels for form fields and buttons.
| captcha : bool, default=True
| If True, requires captcha validation.
| roles : list of str, optional
| User roles for registered users.
| merge_username_email : bool, default=False
| If True, uses the email as the username.
| password_hint : bool, default=True
| If True, includes a password hint field.
| two_factor_auth : bool, default=False
| If True, enables two-factor authentication.
| clear_on_submit : bool, default=False
| If True, clears input fields after form submission.
| key : str, default='Register user'
| Unique key for the widget to prevent duplicate WidgetID errors.
| callback : Callable, optional
| Function to execute when the form is submitted.
|
| Returns
| -------
| tuple[str, str, str] or (None, None, None)
| - Email associated with the new user.
| - Username associated with the new user.
| - Name associated with the new user.
|
| reset_password(self, username: str, location: Literal['main', 'sidebar'] = 'main', fields: Optional[Dict[str, str]] = None, clear_on_submit: bool = False, key: str = 'Reset password', callback: Optional[Callable] = None) -> Optional[bool]
| Renders a password reset widget.
|
| Parameters
| ----------
| username : str
| Username of the user whose password is being reset.
| location : {'main', 'sidebar'}, default='main'
| Location where the password reset widget is rendered.
| fields : dict, optional
| Custom labels for form fields and buttons.
| clear_on_submit : bool, default=False
| If True, clears input fields after form submission.
| key : str, default='Reset password'
| Unique key for the widget to prevent duplicate WidgetID errors.
| callback : Callable, optional
| Function to execute when the form is submitted.
|
| Returns
| -------
| bool or None
| - True if the password reset was successful.
| - None if the reset failed or was not attempted.
|
| update_user_details(self, username: str, location: Literal['main', 'sidebar'] = 'main', fields: Optional[Dict[str, str]] = None, clear_on_submit: bool = False, key: str = 'Update user details', callback: Optional[Callable] = None) -> bool
| Renders an update user details widget.
|
| Parameters
| ----------
| username : str
| Username of the user whose details are being updated.
| location : {'main', 'sidebar'}, default='main'
| Location where the update user details widget is rendered.
| fields : dict, optional
| Custom labels for form fields and buttons.
| clear_on_submit : bool, default=False
| If True, clears input fields after form submission.
| key : str, default='Update user details'
| Unique key for the widget to prevent duplicate WidgetID errors.
| callback : Callable, optional
| Function to execute when the form is submitted.
|
| Returns
| -------
| bool or None
| - True if user details were successfully updated.
| - None if the update failed or was not attempted.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
streamlit-authenticator.AuthenticateError
Python Library Documentation: class AuthenticateError in module streamlit_authenticator.utilities.exceptions class AuthenticateError(builtins.Exception) | AuthenticateError(message: str) -> None | | Exceptions raised in the Authenticate class. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | AuthenticateError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.CloudError
Python Library Documentation: class CloudError in module streamlit_authenticator.utilities.exceptions class CloudError(builtins.Exception) | CloudError(message: str) -> None | | Exception raised for cloud-related errors. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | CloudError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.CredentialsError
Python Library Documentation: class CredentialsError in module streamlit_authenticator.utilities.exceptions
class CredentialsError(builtins.Exception)
| CredentialsError(credential_type: str = '') -> None
|
| Exception raised for incorrect credentials.
|
| Parameters
| ----------
| credential_type : str, optional
| Type of credential that caused the error ('username' or 'password').
|
| Method resolution order:
| CredentialsError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, credential_type: str = '') -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
streamlit-authenticator.DeprecationError
Python Library Documentation: class DeprecationError in module streamlit_authenticator.utilities.exceptions class DeprecationError(builtins.Exception) | DeprecationError(message: str) -> None | | Exception raised for deprecated functionality. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | DeprecationError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.Encryptor
Python Library Documentation: class Encryptor in module streamlit_authenticator.utilities.encryptor class Encryptor(builtins.object) | Encryptor(secret_key: str) -> None | | This class provides encryption and decryption of plain text strings. | | Methods defined here: | | __init__(self, secret_key: str) -> None | Initializes the Encryptor instance. | | Parameters | ---------- | secret_key : str | A secret key used for encryption and decryption. | | decrypt(self, string: str) -> str | Decrypts an encrypted string. | | Parameters | ---------- | string : str | The encrypted text as a base64-encoded string. | | Returns | ------- | str | The decrypted plain text. | | encrypt(self, string: str) -> str | Encrypts a plain text string. | | Parameters | ---------- | string : str | The plain text string to encrypt. | | Returns | ------- | str | The encrypted text as a base64-encoded string. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
streamlit-authenticator.ForgotError
Python Library Documentation: class ForgotError in module streamlit_authenticator.utilities.exceptions class ForgotError(builtins.Exception) | ForgotError(message: str) -> None | | Exception raised for errors in the forgotten username/password process. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | ForgotError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.Hasher
Python Library Documentation: class Hasher in module streamlit_authenticator.utilities.hasher class Hasher(builtins.object) | Hasher() -> None | | This class provides methods for hashing and verifying passwords. | | Methods defined here: | | __init__(self) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Class methods defined here: | | check_pw(password: str, hashed_password: str) -> bool | Verifies if a plain text password matches a hashed password. | | Parameters | ---------- | password : str | The plain text password. | hashed_password : str | The hashed password to compare against. | | Returns | ------- | bool | True if the password matches the hash, False otherwise. | | hash(password: str) -> str | Hashes a plain text password using bcrypt. | | Parameters | ---------- | password : str | The plain text password. | | Returns | ------- | str | The securely hashed password. | | hash_list(passwords: List[str]) -> List[str] | Hashes a list of plain text passwords. | | Parameters | ---------- | passwords : list of str | The list of plain text passwords to be hashed. | | Returns | ------- | list of str | The list of securely hashed passwords. | | hash_passwords(credentials: Dict[str, Dict[str, str]]) -> Dict[str, Dict[str, str]] | Hashes all plain text passwords in a credentials dictionary. | | Parameters | ---------- | credentials : dict | Dictionary containing usernames as keys and user details as values. | | Returns | ------- | dict | The credentials dictionary with all passwords securely hashed. | | is_hash(hash_string: str) -> bool | Determines if a given string is a bcrypt hash. | | Parameters | ---------- | hash_string : str | The string to check. | | Returns | ------- | bool | True if the string is a valid bcrypt hash, False otherwise. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
streamlit-authenticator.Helpers
Python Library Documentation: class Helpers in module streamlit_authenticator.utilities.helpers class Helpers(builtins.object) | Helpers() -> None | | This class provides various helper functions for authentication and configuration handling. | | Methods defined here: | | __init__(self) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Class methods defined here: | | check_captcha(captcha_name: str, entered_captcha: str, secret_key: str) | Checks the validity of the entered captcha. | | Parameters | ---------- | captcha_name : str | Name of the generated captcha stored in the session state. | entered_captcha : str | User-entered captcha to validate against the stored captcha. | secret_key : str | A secret key used for encryption and decryption. | | Returns | ------- | bool | True if the entered captcha is valid, False otherwise. | | generate_captcha(captcha_name: str, secret_key: str) -> captcha.image.ImageCaptcha | Generates a captcha image and stores the associated captcha string in session state. | | Parameters | ---------- | captcha_name : str | Name of the generated captcha stored in the session state. | secret_key : str | A secret key used for encryption and decryption. | | Returns | ------- | ImageCaptcha | The generated captcha image. | | generate_random_string(length: int = 16, letters: bool = True, digits: bool = True, punctuation: bool = True) -> str | Generates a random string with optional character sets. | | Parameters | ---------- | length : int, default=16 | Length of the generated string. | letters : bool, default=True | If True, includes uppercase and lowercase letters. | digits : bool, default=True | If True, includes numerical digits. | punctuation : bool, default=True | If True, includes punctuation symbols. | | Returns | ------- | str | A randomly generated string. | | read_config_file(path: str) -> dict | Reads a configuration file in YAML format. | | Parameters | ---------- | path : str | File path of the configuration file. | | Returns | ------- | dict | Parsed YAML configuration. | | update_config_file(path: str, key: str, items: dict) -> None | Updates a specific key in a YAML configuration file. | | Parameters | ---------- | path : str | File path of the configuration file. | key : str | The key to update in the configuration. | items : dict | The new values to set for the key. | | write_config_file(path: str, config: dict) -> None | Writes a configuration dictionary to a YAML file. | | Parameters | ---------- | path : str | File path of the configuration file. | config : dict | Configuration data to write. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
streamlit-authenticator.LoginError
Python Library Documentation: class LoginError in module streamlit_authenticator.utilities.exceptions class LoginError(builtins.Exception) | LoginError(message: str) -> None | | Exception raised for login-related errors. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | LoginError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.LogoutError
Python Library Documentation: class LogoutError in module streamlit_authenticator.utilities.exceptions class LogoutError(builtins.Exception) | LogoutError(message: str) -> None | | Exception raised for errors related to the logout process. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | LogoutError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.RegisterError
Python Library Documentation: class RegisterError in module streamlit_authenticator.utilities.exceptions class RegisterError(builtins.Exception) | RegisterError(message: str) -> None | | Exception raised for errors in the user registration process. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | RegisterError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.ResetError
Python Library Documentation: class ResetError in module streamlit_authenticator.utilities.exceptions class ResetError(builtins.Exception) | ResetError(message: str) -> None | | Exception raised for errors in the password reset process. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | ResetError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.SafeLoader
Python Library Documentation: class SafeLoader in module yaml.loader
class SafeLoader(yaml.reader.Reader, yaml.scanner.Scanner, yaml.parser.Parser, yaml.composer.Composer, yaml.constructor.SafeConstructor, yaml.resolver.Resolver)
| SafeLoader(stream)
|
| Method resolution order:
| SafeLoader
| yaml.reader.Reader
| yaml.scanner.Scanner
| yaml.parser.Parser
| yaml.composer.Composer
| yaml.constructor.SafeConstructor
| yaml.constructor.BaseConstructor
| yaml.resolver.Resolver
| yaml.resolver.BaseResolver
| builtins.object
|
| Methods defined here:
|
| __init__(self, stream)
| Initialize the scanner.
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.reader.Reader:
|
| check_printable(self, data)
|
| determine_encoding(self)
|
| forward(self, length=1)
|
| get_mark(self)
|
| peek(self, index=0)
|
| prefix(self, length=1)
|
| update(self, length)
|
| update_raw(self, size=4096)
|
| ----------------------------------------------------------------------
| Data descriptors inherited from yaml.reader.Reader:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.reader.Reader:
|
| NON_PRINTABLE = re.compile('[^\t\n\r -~\x85\xa0-\ud7ff\ue000-�𐀀-\U0010...
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.scanner.Scanner:
|
| add_indent(self, column)
|
| check_block_entry(self)
|
| check_directive(self)
|
| check_document_end(self)
|
| check_document_start(self)
|
| check_key(self)
|
| check_plain(self)
|
| check_token(self, *choices)
|
| check_value(self)
|
| fetch_alias(self)
|
| fetch_anchor(self)
|
| fetch_block_entry(self)
|
| fetch_block_scalar(self, style)
|
| fetch_directive(self)
|
| fetch_document_end(self)
|
| fetch_document_indicator(self, TokenClass)
|
| fetch_document_start(self)
|
| fetch_double(self)
|
| fetch_flow_collection_end(self, TokenClass)
|
| fetch_flow_collection_start(self, TokenClass)
|
| fetch_flow_entry(self)
|
| fetch_flow_mapping_end(self)
|
| fetch_flow_mapping_start(self)
|
| fetch_flow_scalar(self, style)
|
| fetch_flow_sequence_end(self)
|
| fetch_flow_sequence_start(self)
|
| fetch_folded(self)
|
| fetch_key(self)
|
| fetch_literal(self)
|
| fetch_more_tokens(self)
|
| fetch_plain(self)
|
| fetch_single(self)
|
| fetch_stream_end(self)
|
| fetch_stream_start(self)
|
| fetch_tag(self)
|
| fetch_value(self)
|
| get_token(self)
|
| need_more_tokens(self)
|
| next_possible_simple_key(self)
|
| peek_token(self)
|
| remove_possible_simple_key(self)
|
| save_possible_simple_key(self)
|
| scan_anchor(self, TokenClass)
|
| scan_block_scalar(self, style)
|
| scan_block_scalar_breaks(self, indent)
|
| scan_block_scalar_ignored_line(self, start_mark)
|
| scan_block_scalar_indentation(self)
|
| scan_block_scalar_indicators(self, start_mark)
|
| scan_directive(self)
|
| scan_directive_ignored_line(self, start_mark)
|
| scan_directive_name(self, start_mark)
|
| scan_flow_scalar(self, style)
|
| scan_flow_scalar_breaks(self, double, start_mark)
|
| scan_flow_scalar_non_spaces(self, double, start_mark)
|
| scan_flow_scalar_spaces(self, double, start_mark)
|
| scan_line_break(self)
|
| scan_plain(self)
|
| scan_plain_spaces(self, indent, start_mark)
|
| scan_tag(self)
|
| scan_tag_directive_handle(self, start_mark)
|
| scan_tag_directive_prefix(self, start_mark)
|
| scan_tag_directive_value(self, start_mark)
|
| scan_tag_handle(self, name, start_mark)
|
| scan_tag_uri(self, name, start_mark)
|
| scan_to_next_token(self)
|
| scan_uri_escapes(self, name, start_mark)
|
| scan_yaml_directive_number(self, start_mark)
|
| scan_yaml_directive_value(self, start_mark)
|
| stale_possible_simple_keys(self)
|
| unwind_indent(self, column)
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.scanner.Scanner:
|
| ESCAPE_CODES = {'U': 8, 'u': 4, 'x': 2}
|
| ESCAPE_REPLACEMENTS = {'\t': '\t', ' ': ' ', '"': '"', '/': '/', '0': ...
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.parser.Parser:
|
| check_event(self, *choices)
|
| dispose(self)
|
| get_event(self)
|
| parse_block_mapping_first_key(self)
|
| parse_block_mapping_key(self)
|
| parse_block_mapping_value(self)
|
| parse_block_node(self)
|
| parse_block_node_or_indentless_sequence(self)
|
| parse_block_sequence_entry(self)
|
| parse_block_sequence_first_entry(self)
|
| parse_document_content(self)
|
| parse_document_end(self)
|
| parse_document_start(self)
|
| parse_flow_mapping_empty_value(self)
|
| parse_flow_mapping_first_key(self)
|
| parse_flow_mapping_key(self, first=False)
|
| parse_flow_mapping_value(self)
|
| parse_flow_node(self)
|
| parse_flow_sequence_entry(self, first=False)
|
| parse_flow_sequence_entry_mapping_end(self)
|
| parse_flow_sequence_entry_mapping_key(self)
|
| parse_flow_sequence_entry_mapping_value(self)
|
| parse_flow_sequence_first_entry(self)
|
| parse_implicit_document_start(self)
|
| parse_indentless_sequence_entry(self)
|
| parse_node(self, block=False, indentless_sequence=False)
|
| parse_stream_start(self)
|
| peek_event(self)
|
| process_directives(self)
|
| process_empty_scalar(self, mark)
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.parser.Parser:
|
| DEFAULT_TAGS = {'!': '!', '!!': 'tag:yaml.org,2002:'}
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.composer.Composer:
|
| check_node(self)
|
| compose_document(self)
|
| compose_mapping_node(self, anchor)
|
| compose_node(self, parent, index)
|
| compose_scalar_node(self, anchor)
|
| compose_sequence_node(self, anchor)
|
| get_node(self)
|
| get_single_node(self)
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.constructor.SafeConstructor:
|
| construct_mapping(self, node, deep=False)
|
| construct_scalar(self, node)
|
| construct_undefined(self, node)
|
| construct_yaml_binary(self, node)
|
| construct_yaml_bool(self, node)
|
| construct_yaml_float(self, node)
|
| construct_yaml_int(self, node)
|
| construct_yaml_map(self, node)
|
| construct_yaml_null(self, node)
|
| construct_yaml_object(self, node, cls)
|
| construct_yaml_omap(self, node)
|
| construct_yaml_pairs(self, node)
|
| construct_yaml_seq(self, node)
|
| construct_yaml_set(self, node)
|
| construct_yaml_str(self, node)
|
| construct_yaml_timestamp(self, node)
|
| flatten_mapping(self, node)
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.constructor.SafeConstructor:
|
| bool_values = {'false': False, 'no': False, 'off': False, 'on': True, ...
|
| inf_value = inf
|
| nan_value = nan
|
| timestamp_regexp = re.compile('^(?P<year>[0-9][0-9][0-9][0-9])\n ......
|
| yaml_constructors = {'tag:yaml.org,2002:null': <function SafeConstruct...
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.constructor.BaseConstructor:
|
| check_data(self)
|
| check_state_key(self, key)
| Block special attributes/methods from being set in a newly created
| object, to prevent user-controlled methods from being called during
| deserialization
|
| construct_document(self, node)
|
| construct_object(self, node, deep=False)
|
| construct_pairs(self, node, deep=False)
|
| construct_sequence(self, node, deep=False)
|
| get_data(self)
|
| get_single_data(self)
|
| ----------------------------------------------------------------------
| Class methods inherited from yaml.constructor.BaseConstructor:
|
| add_constructor(tag, constructor)
|
| add_multi_constructor(tag_prefix, multi_constructor)
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.constructor.BaseConstructor:
|
| yaml_multi_constructors = {}
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.resolver.Resolver:
|
| yaml_implicit_resolvers = {'': [('tag:yaml.org,2002:null', re.compile(...
|
| ----------------------------------------------------------------------
| Methods inherited from yaml.resolver.BaseResolver:
|
| ascend_resolver(self)
|
| check_resolver_prefix(self, depth, path, kind, current_node, current_index)
|
| descend_resolver(self, current_node, current_index)
|
| resolve(self, kind, value, implicit)
|
| ----------------------------------------------------------------------
| Class methods inherited from yaml.resolver.BaseResolver:
|
| add_implicit_resolver(tag, regexp, first)
|
| add_path_resolver(tag, path, kind=None)
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from yaml.resolver.BaseResolver:
|
| DEFAULT_MAPPING_TAG = 'tag:yaml.org,2002:map'
|
| DEFAULT_SCALAR_TAG = 'tag:yaml.org,2002:str'
|
| DEFAULT_SEQUENCE_TAG = 'tag:yaml.org,2002:seq'
|
| yaml_path_resolvers = {}
streamlit-authenticator.UpdateError
Python Library Documentation: class UpdateError in module streamlit_authenticator.utilities.exceptions class UpdateError(builtins.Exception) | UpdateError(message: str) -> None | | Exception raised for errors in updating user details. | | Parameters | ---------- | message : str | The custom error message to display. | | Method resolution order: | UpdateError | builtins.Exception | builtins.BaseException | builtins.object | | Methods defined here: | | __init__(self, message: str) -> None | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) class method of builtins.Exception | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | add_note(...) | Exception.add_note(note) -- | add a note to the exception | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args
streamlit-authenticator.Validator
Python Library Documentation: class Validator in module streamlit_authenticator.utilities.validator class Validator(builtins.object) | This class provides validation methods for usernames, names, emails, and passwords. | | Methods defined here: | | __init__(self) | Initialize self. See help(type(self)) for accurate signature. | | diagnose_password(self, password: str) -> str | Diagnoses the validity of the entered password and returns an error message if invalid. | | Parameters | ---------- | password : str | The password to be diagnosed. | | Returns | ------- | str | Error message listing password requirements that were not met. | | validate_email(self, email: str) -> bool | Checks the validity of the entered email. | | Parameters | ---------- | email : str | The email to be validated. | | Returns | ------- | bool | True if the email is valid, False otherwise. | | validate_length(self, variable: str, min_length: int = 0, max_length: int = 254) -> bool | Checks if a given string is within the specified length range. | | Parameters | ---------- | variable : str | The string to be validated. | min_length : int, default=0 | The minimum required length for the string. | max_length : int, default=254 | The maximum allowed length for the string. | | Returns | ------- | bool | True if the string length is within range, False otherwise. | | validate_name(self, name: str) -> bool | Checks the validity of the entered name. | | Parameters | ---------- | name : str | The name to be validated. | | Returns | ------- | bool | True if the name is valid, False otherwise. | | validate_password(self, password: str) -> bool | Checks the validity of the entered password. | | Parameters | ---------- | password : str | The password to be validated. | | Returns | ------- | bool | True if the password is valid, False otherwise. | | validate_username(self, username: str) -> bool | Checks the validity of the entered username. | | Parameters | ---------- | username : str | The username to be validated. | | Returns | ------- | bool | True if the username is valid, False otherwise. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
streamlit-authenticator.components
Python Library Documentation: package streamlit.components.v1 in streamlit.components
NAME
streamlit.components.v1 - Contains the files and modules for the exposed API.
PACKAGE CONTENTS
component_arrow
component_registry
components
custom_component
FUNCTIONS
declare_component(name: 'str', path: 'str | Path | None' = None, url: 'str | None' = None) -> 'CustomComponent'
Create a custom component and register it if there is a ``ScriptRunContext``.
The component is not registered when there is no ``ScriptRunContext``.
This can happen when a ``CustomComponent`` is executed as standalone
command (e.g. for testing).
To use this function, import it from the ``streamlit.components.v1``
module.
.. warning::
Using ``st.components.v1.declare_component`` directly (instead of
importing its module) is deprecated and will be disallowed in a later
version.
Parameters
----------
name : str
A short, descriptive name for the component, like "slider".
path: str, Path, or None
The path to serve the component's frontend files from. The path should
be absolute. If ``path`` is ``None`` (default), Streamlit will serve
the component from the location in ``url``. Either ``path`` or ``url``
must be specified. If both are specified, then ``url`` will take
precedence.
url: str or None
The URL that the component is served from. If ``url`` is ``None``
(default), Streamlit will serve the component from the location in
``path``. Either ``path`` or ``url`` must be specified. If both are
specified, then ``url`` will take precedence.
Returns
-------
CustomComponent
A ``CustomComponent`` that can be called like a function.
Calling the component will create a new instance of the component
in the Streamlit app.
html = components.v1.html(self, html: 'str', width: 'int | None' = None, height: 'int | None' = None, scrolling: 'bool' = False, *, tab_index: 'int | None' = None) -> 'DeltaGenerator'
Display an HTML string in an iframe.
To use this function, import it from the ``streamlit.components.v1``
module.
If you want to insert HTML text into your app without an iframe, try
``st.html`` instead.
.. deprecated::
``st.components.v1.html`` is deprecated and will be removed in a
future release. Please use ``st.iframe`` instead, which provides
the same functionality with additional features like automatic
content sizing and local file support.
.. warning::
Using ``st.components.v1.html`` directly (instead of importing
its module) is deprecated and will be disallowed in a later version.
Parameters
----------
html : str
The HTML string to embed in the iframe.
width : int
The width of the iframe in CSS pixels. By default, this is the
app's default element width.
height : int
The height of the frame in CSS pixels. By default, this is ``150``.
scrolling : bool
Whether to allow scrolling in the iframe. If this ``False``
(default), Streamlit crops any content larger than the iframe and
does not show a scrollbar. If this is ``True``, Streamlit shows a
scrollbar when the content is larger than the iframe.
tab_index : int or None
Specifies how and if the iframe is sequentially focusable.
Users typically use the ``Tab`` key for sequential focus
navigation.
This can be one of the following values:
- ``None`` (default): Uses the browser's default behavior.
- ``-1``: Removes the iframe from sequential navigation, but still
allows it to be focused programmatically.
- ``0``: Includes the iframe in sequential navigation in the order
it appears in the document but after all elements with a positive
``tab_index``.
- Positive integer: Includes the iframe in sequential navigation.
Elements are navigated in ascending order of their positive
``tab_index``.
For more information, see the `tabindex
<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex>`_
documentation on MDN.
Examples
--------
>>> import streamlit.components.v1 as components
>>>
>>> components.html(
>>> "<p><span style='text-decoration: line-through double red;'>Oops</span>!</p>"
>>> )
iframe = components.v1.iframe(self, src: 'str', width: 'int | None' = None, height: 'int | None' = None, scrolling: 'bool' = False, *, tab_index: 'int | None' = None) -> 'DeltaGenerator'
Load a remote URL in an iframe.
To use this function, import it from the ``streamlit.components.v1``
module.
.. deprecated::
``st.components.v1.iframe`` is deprecated and will be removed in a
future release. Please use ``st.iframe`` instead, which provides
the same functionality with additional features like automatic
content sizing and local file support.
.. warning::
Using ``st.components.v1.iframe`` directly (instead of importing
its module) is deprecated and will be disallowed in a later version.
Parameters
----------
src : str
The URL of the page to embed.
width : int
The width of the iframe in CSS pixels. By default, this is the
app's default element width.
height : int
The height of the frame in CSS pixels. By default, this is ``150``.
scrolling : bool
Whether to allow scrolling in the iframe. If this ``False``
(default), Streamlit crops any content larger than the iframe and
does not show a scrollbar. If this is ``True``, Streamlit shows a
scrollbar when the content is larger than the iframe.
tab_index : int or None
Specifies how and if the iframe is sequentially focusable.
Users typically use the ``Tab`` key for sequential focus
navigation.
This can be one of the following values:
- ``None`` (default): Uses the browser's default behavior.
- ``-1``: Removes the iframe from sequential navigation, but still
allows it to be focused programmatically.
- ``0``: Includes the iframe in sequential navigation in the order
it appears in the document but after all elements with a positive
``tab_index``.
- Positive integer: Includes the iframe in sequential navigation.
Elements are navigated in ascending order of their positive
``tab_index``.
For more information, see the `tabindex
<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex>`_
documentation on MDN.
Examples
--------
>>> import streamlit.components.v1 as components
>>>
>>> components.iframe("https://example.com", height=500)
DATA
__all__ = ['declare_component', 'html', 'iframe']
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit\components\v1\__init__.py
streamlit-authenticator.controllers
Python Library Documentation: package streamlit_authenticator.controllers in streamlit_authenticator
NAME
streamlit_authenticator.controllers
PACKAGE CONTENTS
authentication_controller
cookie_controller
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\controllers\__init__.py
streamlit-authenticator.encryptor
Python Library Documentation: module streamlit_authenticator.utilities.encryptor in streamlit_authenticator.utilities
NAME
streamlit_authenticator.utilities.encryptor - Script description: Handles encryption and decryption of plain text using AES-based encryption.
DESCRIPTION
Libraries Imported:
-------------------
- base64: Encodes and decodes data in a URL-safe format.
- hashlib: Implements hashing for security.
- cryptography: Provides secure encryption and decryption.
CLASSES
builtins.object
Encryptor
class Encryptor(builtins.object)
| Encryptor(secret_key: str) -> None
|
| This class provides encryption and decryption of plain text strings.
|
| Methods defined here:
|
| __init__(self, secret_key: str) -> None
| Initializes the Encryptor instance.
|
| Parameters
| ----------
| secret_key : str
| A secret key used for encryption and decryption.
|
| decrypt(self, string: str) -> str
| Decrypts an encrypted string.
|
| Parameters
| ----------
| string : str
| The encrypted text as a base64-encoded string.
|
| Returns
| -------
| str
| The decrypted plain text.
|
| encrypt(self, string: str) -> str
| Encrypts a plain text string.
|
| Parameters
| ----------
| string : str
| The plain text string to encrypt.
|
| Returns
| -------
| str
| The encrypted text as a base64-encoded string.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\utilities\encryptor.py
streamlit-authenticator.exceptions
Python Library Documentation: module streamlit_authenticator.utilities.exceptions in streamlit_authenticator.utilities
NAME
streamlit_authenticator.utilities.exceptions
DESCRIPTION
Script description: Handles custom exceptions for errors occurring in authentication processes,
such as login failures, incorrect credentials, deprecated functionality, and
issues related to password resets and user updates.
CLASSES
builtins.Exception(builtins.BaseException)
AuthenticateError
CloudError
CredentialsError
DeprecationError
ForgotError
LoginError
LogoutError
RegisterError
ResetError
TwoFactorAuthError
UpdateError
class AuthenticateError(builtins.Exception)
| AuthenticateError(message: str) -> None
|
| Exceptions raised in the Authenticate class.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| AuthenticateError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class CloudError(builtins.Exception)
| CloudError(message: str) -> None
|
| Exception raised for cloud-related errors.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| CloudError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class CredentialsError(builtins.Exception)
| CredentialsError(credential_type: str = '') -> None
|
| Exception raised for incorrect credentials.
|
| Parameters
| ----------
| credential_type : str, optional
| Type of credential that caused the error ('username' or 'password').
|
| Method resolution order:
| CredentialsError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, credential_type: str = '') -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class DeprecationError(builtins.Exception)
| DeprecationError(message: str) -> None
|
| Exception raised for deprecated functionality.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| DeprecationError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ForgotError(builtins.Exception)
| ForgotError(message: str) -> None
|
| Exception raised for errors in the forgotten username/password process.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| ForgotError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class LoginError(builtins.Exception)
| LoginError(message: str) -> None
|
| Exception raised for login-related errors.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| LoginError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class LogoutError(builtins.Exception)
| LogoutError(message: str) -> None
|
| Exception raised for errors related to the logout process.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| LogoutError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class RegisterError(builtins.Exception)
| RegisterError(message: str) -> None
|
| Exception raised for errors in the user registration process.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| RegisterError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class ResetError(builtins.Exception)
| ResetError(message: str) -> None
|
| Exception raised for errors in the password reset process.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| ResetError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class TwoFactorAuthError(builtins.Exception)
| TwoFactorAuthError(message: str) -> None
|
| Exception raised for errors in two-factor authentication.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| TwoFactorAuthError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
class UpdateError(builtins.Exception)
| UpdateError(message: str) -> None
|
| Exception raised for errors in updating user details.
|
| Parameters
| ----------
| message : str
| The custom error message to display.
|
| Method resolution order:
| UpdateError
| builtins.Exception
| builtins.BaseException
| builtins.object
|
| Methods defined here:
|
| __init__(self, message: str) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.Exception:
|
| __new__(*args, **kwargs) class method of builtins.Exception
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.BaseException:
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __reduce__(...)
| Helper for pickle.
|
| __repr__(self, /)
| Return repr(self).
|
| __setstate__(...)
|
| __str__(self, /)
| Return str(self).
|
| add_note(...)
| Exception.add_note(note) --
| add a note to the exception
|
| with_traceback(...)
| Exception.with_traceback(tb) --
| set self.__traceback__ to tb and return self.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.BaseException:
|
| __cause__
| exception cause
|
| __context__
| exception context
|
| __dict__
|
| __suppress_context__
|
| __traceback__
|
| args
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\utilities\exceptions.py
streamlit-authenticator.hasher
Python Library Documentation: module streamlit_authenticator.utilities.hasher in streamlit_authenticator.utilities
NAME
streamlit_authenticator.utilities.hasher - Script description: Handles secure hashing and validation of plain text passwords using bcrypt.
DESCRIPTION
Libraries Imported:
-------------------
- re: Implements regular expressions for pattern matching.
- bcrypt: Provides secure password hashing.
- typing: Provides standard type hints for Python functions.
CLASSES
builtins.object
Hasher
class Hasher(builtins.object)
| Hasher() -> None
|
| This class provides methods for hashing and verifying passwords.
|
| Methods defined here:
|
| __init__(self) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| check_pw(password: str, hashed_password: str) -> bool
| Verifies if a plain text password matches a hashed password.
|
| Parameters
| ----------
| password : str
| The plain text password.
| hashed_password : str
| The hashed password to compare against.
|
| Returns
| -------
| bool
| True if the password matches the hash, False otherwise.
|
| hash(password: str) -> str
| Hashes a plain text password using bcrypt.
|
| Parameters
| ----------
| password : str
| The plain text password.
|
| Returns
| -------
| str
| The securely hashed password.
|
| hash_list(passwords: List[str]) -> List[str]
| Hashes a list of plain text passwords.
|
| Parameters
| ----------
| passwords : list of str
| The list of plain text passwords to be hashed.
|
| Returns
| -------
| list of str
| The list of securely hashed passwords.
|
| hash_passwords(credentials: Dict[str, Dict[str, str]]) -> Dict[str, Dict[str, str]]
| Hashes all plain text passwords in a credentials dictionary.
|
| Parameters
| ----------
| credentials : dict
| Dictionary containing usernames as keys and user details as values.
|
| Returns
| -------
| dict
| The credentials dictionary with all passwords securely hashed.
|
| is_hash(hash_string: str) -> bool
| Determines if a given string is a bcrypt hash.
|
| Parameters
| ----------
| hash_string : str
| The string to check.
|
| Returns
| -------
| bool
| True if the string is a valid bcrypt hash, False otherwise.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
DATA
Dict = typing.Dict
A generic version of dict.
List = typing.List
A generic version of list.
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\utilities\hasher.py
streamlit-authenticator.helpers
Python Library Documentation: module streamlit_authenticator.utilities.helpers in streamlit_authenticator.utilities
NAME
streamlit_authenticator.utilities.helpers - Script description: This module provides miscellaneous utility functions for authentication and configuration.
DESCRIPTION
Libraries Imported:
-------------------
- yaml: Handles data serialization for human-readable configuration files.
- string: Provides support for ASCII character encoding.
- random: Generates random characters.
- streamlit: Framework used to build web applications.
- captcha: Generates captcha images.
CLASSES
builtins.object
Helpers
class Helpers(builtins.object)
| Helpers() -> None
|
| This class provides various helper functions for authentication and configuration handling.
|
| Methods defined here:
|
| __init__(self) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Class methods defined here:
|
| check_captcha(captcha_name: str, entered_captcha: str, secret_key: str)
| Checks the validity of the entered captcha.
|
| Parameters
| ----------
| captcha_name : str
| Name of the generated captcha stored in the session state.
| entered_captcha : str
| User-entered captcha to validate against the stored captcha.
| secret_key : str
| A secret key used for encryption and decryption.
|
| Returns
| -------
| bool
| True if the entered captcha is valid, False otherwise.
|
| generate_captcha(captcha_name: str, secret_key: str) -> captcha.image.ImageCaptcha
| Generates a captcha image and stores the associated captcha string in session state.
|
| Parameters
| ----------
| captcha_name : str
| Name of the generated captcha stored in the session state.
| secret_key : str
| A secret key used for encryption and decryption.
|
| Returns
| -------
| ImageCaptcha
| The generated captcha image.
|
| generate_random_string(length: int = 16, letters: bool = True, digits: bool = True, punctuation: bool = True) -> str
| Generates a random string with optional character sets.
|
| Parameters
| ----------
| length : int, default=16
| Length of the generated string.
| letters : bool, default=True
| If True, includes uppercase and lowercase letters.
| digits : bool, default=True
| If True, includes numerical digits.
| punctuation : bool, default=True
| If True, includes punctuation symbols.
|
| Returns
| -------
| str
| A randomly generated string.
|
| read_config_file(path: str) -> dict
| Reads a configuration file in YAML format.
|
| Parameters
| ----------
| path : str
| File path of the configuration file.
|
| Returns
| -------
| dict
| Parsed YAML configuration.
|
| update_config_file(path: str, key: str, items: dict) -> None
| Updates a specific key in a YAML configuration file.
|
| Parameters
| ----------
| path : str
| File path of the configuration file.
| key : str
| The key to update in the configuration.
| items : dict
| The new values to set for the key.
|
| write_config_file(path: str, config: dict) -> None
| Writes a configuration dictionary to a YAML file.
|
| Parameters
| ----------
| path : str
| File path of the configuration file.
| config : dict
| Configuration data to write.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\utilities\helpers.py
streamlit-authenticator.models
Python Library Documentation: package streamlit_authenticator.models in streamlit_authenticator
NAME
streamlit_authenticator.models
PACKAGE CONTENTS
authentication_model
cloud (package)
cookie_model
oauth2 (package)
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\models\__init__.py
streamlit-authenticator.params
Python Library Documentation: module streamlit_authenticator.params in streamlit_authenticator
NAME
streamlit_authenticator.params - Configuration parameters and links for the Streamlit-Authenticator package.
DATA
AUTO_HASH_MAX_USERS = 30
AUTO_HASH_MAX_USERS_LINK = 'https://github.com/mkhorasani/Streamlit-Au...
PASSWORD_INSTRUCTIONS = '\n **P...
PRE_GUEST_LOGIN_SLEEP_TIME = 0.7
PRE_LOGIN_SLEEP_TIME = 0.7
REGISTER_USER_LINK = 'https://github.com/mkhorasani/Streamlit-Authenti...
REMOTE_VARIABLES_LINK = 'https://raw.githubusercontent.com/mkhorasani/...
SEND_EMAIL = '/send_email'
SERVER_URL = 'https://mkhorasani.pythonanywhere.com'
TIMEOUT = 30
TWO_FACTOR_AUTH_LINK = 'https://github.com/mkhorasani/Streamlit-Authen...
__annotations__ = {'AUTO_HASH_MAX_USERS': <class 'int'>, 'AUTO_HASH_MA...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\params.py
streamlit-authenticator.st
Python Library Documentation: package streamlit
NAME
streamlit - Streamlit.
DESCRIPTION
How to use Streamlit in 3 seconds:
1. Write an app
>>> import streamlit as st
>>> st.write(anything_you_want)
2. Run your app
$ streamlit run my_script.py
3. Use your app
A new tab will open on your browser. That's your Streamlit app!
4. Modify your code, save it, and watch changes live on your browser.
Take a look at the other commands in this module to find out what else
Streamlit can do:
>>> dir(streamlit)
Or try running our "Hello World":
$ streamlit hello
For more detailed info, see https://docs.streamlit.io.
PACKAGE CONTENTS
__main__
auth_util
cli_util
column_config
commands (package)
components (package)
config
config_option
config_util
connections (package)
cursor
dataframe_util
delta_generator
delta_generator_singletons
deprecation_util
development
elements (package)
emojis
env_util
error_util
errors
external (package)
file_util
git_util
hello (package)
logger
material_icon_names
navigation (package)
net_util
path_security
platform
proto (package)
runtime (package)
source_util
starlette
string_util
temporary_directory
testing (package)
time_util
type_util
url_util
user_info
util
vendor (package)
version
watcher (package)
web (package)
SUBMODULES
_column_config
_config
_logger
DATA
__annotations__ = {'_bottom': <class 'streamlit.delta_generator.DeltaG...
bottom = <streamlit.elements.bottom.BottomContainerProxy object>
cache_data = <streamlit.runtime.caching.cache_data_api.CacheDataAPI ob...
cache_resource = <streamlit.runtime.caching.cache_resource_api.CacheRe...
context = <streamlit.runtime.context.ContextProxy object>
query_params = <streamlit.runtime.state.query_params_proxy.QueryParams...
secrets = Secrets
session_state = <streamlit.runtime.state.session_state_proxy.SessionSt...
sidebar = DeltaGenerator(_root_container=1, _parent=DeltaGenerator())
user = <streamlit.user_info.UserInfoProxy object>
VERSION
1.57.0
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit\__init__.py
streamlit-authenticator.utilities
Python Library Documentation: package streamlit_authenticator.utilities in streamlit_authenticator
NAME
streamlit_authenticator.utilities
PACKAGE CONTENTS
encryptor
exceptions
hasher
helpers
validator
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\utilities\__init__.py
streamlit-authenticator.validator
Python Library Documentation: module streamlit_authenticator.utilities.validator in streamlit_authenticator.utilities
NAME
streamlit_authenticator.utilities.validator - Script description: This script provides string validations for various user inputs.
DESCRIPTION
Libraries Imported:
-------------------
- re: Implements regular expressions for pattern matching.
CLASSES
builtins.object
Validator
class Validator(builtins.object)
| This class provides validation methods for usernames, names, emails, and passwords.
|
| Methods defined here:
|
| __init__(self)
| Initialize self. See help(type(self)) for accurate signature.
|
| diagnose_password(self, password: str) -> str
| Diagnoses the validity of the entered password and returns an error message if invalid.
|
| Parameters
| ----------
| password : str
| The password to be diagnosed.
|
| Returns
| -------
| str
| Error message listing password requirements that were not met.
|
| validate_email(self, email: str) -> bool
| Checks the validity of the entered email.
|
| Parameters
| ----------
| email : str
| The email to be validated.
|
| Returns
| -------
| bool
| True if the email is valid, False otherwise.
|
| validate_length(self, variable: str, min_length: int = 0, max_length: int = 254) -> bool
| Checks if a given string is within the specified length range.
|
| Parameters
| ----------
| variable : str
| The string to be validated.
| min_length : int, default=0
| The minimum required length for the string.
| max_length : int, default=254
| The maximum allowed length for the string.
|
| Returns
| -------
| bool
| True if the string length is within range, False otherwise.
|
| validate_name(self, name: str) -> bool
| Checks the validity of the entered name.
|
| Parameters
| ----------
| name : str
| The name to be validated.
|
| Returns
| -------
| bool
| True if the name is valid, False otherwise.
|
| validate_password(self, password: str) -> bool
| Checks the validity of the entered password.
|
| Parameters
| ----------
| password : str
| The password to be validated.
|
| Returns
| -------
| bool
| True if the password is valid, False otherwise.
|
| validate_username(self, username: str) -> bool
| Checks the validity of the entered username.
|
| Parameters
| ----------
| username : str
| The username to be validated.
|
| Returns
| -------
| bool
| True if the username is valid, False otherwise.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\utilities\validator.py
streamlit-authenticator.views
Python Library Documentation: package streamlit_authenticator.views in streamlit_authenticator
NAME
streamlit_authenticator.views
PACKAGE CONTENTS
authentication_view
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\streamlit_authenticator\views\__init__.py
streamlit-authenticator.yaml
Python Library Documentation: package yaml
NAME
yaml
PACKAGE CONTENTS
_yaml
composer
constructor
cyaml
dumper
emitter
error
events
loader
nodes
parser
reader
representer
resolver
scanner
serializer
tokens
CLASSES
builtins.object
YAMLObject
builtins.type(builtins.object)
YAMLObjectMetaclass
class YAMLObject(builtins.object)
| An object that can dump itself to a YAML stream
| and load itself from a YAML stream.
|
| Class methods defined here:
|
| from_yaml(loader, node)
| Convert a representation node to a Python object.
|
| to_yaml(dumper, data)
| Convert a Python object to a representation node.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| yaml_dumper = <class 'yaml.dumper.Dumper'>
|
| yaml_flow_style = None
|
| yaml_loader = [<class 'yaml.loader.Loader'>, <class 'yaml.loader.FullL...
|
| yaml_tag = None
class YAMLObjectMetaclass(builtins.type)
| YAMLObjectMetaclass(name, bases, kwds)
|
| The metaclass for YAMLObject.
|
| Method resolution order:
| YAMLObjectMetaclass
| builtins.type
| builtins.object
|
| Methods defined here:
|
| __init__(cls, name, bases, kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.type:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __delattr__(self, name, /)
| Implement delattr(self, name).
|
| __dir__(self, /)
| Specialized __dir__ implementation for types.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __instancecheck__(self, instance, /)
| Check if an object is an instance.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __setattr__(self, name, value, /)
| Implement setattr(self, name, value).
|
| __sizeof__(self, /)
| Return memory consumption of the type object.
|
| __subclasscheck__(self, subclass, /)
| Check if a class is a subclass.
|
| __subclasses__(self, /)
| Return a list of immediate subclasses.
|
| mro(self, /)
| Return a type's method resolution order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.type:
|
| __prepare__(...)
| __prepare__() -> dict
| used to create the namespace for the class statement
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.type:
|
| __new__(*args, **kwargs) class method of builtins.type
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.type:
|
| __abstractmethods__
|
| __dict__
|
| __text_signature__
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.type:
|
| __base__ = <class 'type'>
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
|
|
| __bases__ = (<class 'type'>,)
|
| __basicsize__ = 920
|
| __dictoffset__ = 264
|
| __flags__ = 2156420608
|
| __itemsize__ = 40
|
| __mro__ = (<class 'yaml.YAMLObjectMetaclass'>, <class 'type'>, <class ...
|
| __type_params__ = ()
|
| __weakrefoffset__ = 368
FUNCTIONS
add_constructor(tag, constructor, Loader=None)
Add a constructor for the given tag.
Constructor is a function that accepts a Loader instance
and a node object and produces the corresponding Python object.
add_implicit_resolver(tag, regexp, first=None, Loader=None, Dumper=<class 'yaml.dumper.Dumper'>)
Add an implicit scalar detector.
If an implicit scalar value matches the given regexp,
the corresponding tag is assigned to the scalar.
first is a sequence of possible initial characters or None.
add_multi_constructor(tag_prefix, multi_constructor, Loader=None)
Add a multi-constructor for the given tag prefix.
Multi-constructor is called for a node if its tag starts with tag_prefix.
Multi-constructor accepts a Loader instance, a tag suffix,
and a node object and produces the corresponding Python object.
add_multi_representer(data_type, multi_representer, Dumper=<class 'yaml.dumper.Dumper'>)
Add a representer for the given type.
Multi-representer is a function accepting a Dumper instance
and an instance of the given data type or subtype
and producing the corresponding representation node.
add_path_resolver(tag, path, kind=None, Loader=None, Dumper=<class 'yaml.dumper.Dumper'>)
Add a path based resolver for the given tag.
A path is a list of keys that forms a path
to a node in the representation tree.
Keys can be string values, integers, or None.
add_representer(data_type, representer, Dumper=<class 'yaml.dumper.Dumper'>)
Add a representer for the given type.
Representer is a function accepting a Dumper instance
and an instance of the given data type
and producing the corresponding representation node.
compose(stream, Loader=<class 'yaml.loader.Loader'>)
Parse the first YAML document in a stream
and produce the corresponding representation tree.
compose_all(stream, Loader=<class 'yaml.loader.Loader'>)
Parse all YAML documents in a stream
and produce corresponding representation trees.
dump(data, stream=None, Dumper=<class 'yaml.dumper.Dumper'>, **kwds)
Serialize a Python object into a YAML stream.
If stream is None, return the produced string instead.
dump_all(documents, stream=None, Dumper=<class 'yaml.dumper.Dumper'>, default_style=None, default_flow_style=False, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None, sort_keys=True)
Serialize a sequence of Python objects into a YAML stream.
If stream is None, return the produced string instead.
emit(events, stream=None, Dumper=<class 'yaml.dumper.Dumper'>, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None)
Emit YAML parsing events into a stream.
If stream is None, return the produced string instead.
full_load(stream)
Parse the first YAML document in a stream
and produce the corresponding Python object.
Resolve all tags except those known to be
unsafe on untrusted input.
full_load_all(stream)
Parse all YAML documents in a stream
and produce corresponding Python objects.
Resolve all tags except those known to be
unsafe on untrusted input.
load(stream, Loader)
Parse the first YAML document in a stream
and produce the corresponding Python object.
load_all(stream, Loader)
Parse all YAML documents in a stream
and produce corresponding Python objects.
parse(stream, Loader=<class 'yaml.loader.Loader'>)
Parse a YAML stream and produce parsing events.
safe_dump(data, stream=None, **kwds)
Serialize a Python object into a YAML stream.
Produce only basic YAML tags.
If stream is None, return the produced string instead.
safe_dump_all(documents, stream=None, **kwds)
Serialize a sequence of Python objects into a YAML stream.
Produce only basic YAML tags.
If stream is None, return the produced string instead.
safe_load(stream)
Parse the first YAML document in a stream
and produce the corresponding Python object.
Resolve only basic YAML tags. This is known
to be safe for untrusted input.
safe_load_all(stream)
Parse all YAML documents in a stream
and produce corresponding Python objects.
Resolve only basic YAML tags. This is known
to be safe for untrusted input.
scan(stream, Loader=<class 'yaml.loader.Loader'>)
Scan a YAML stream and produce scanning tokens.
serialize(node, stream=None, Dumper=<class 'yaml.dumper.Dumper'>, **kwds)
Serialize a representation tree into a YAML stream.
If stream is None, return the produced string instead.
serialize_all(nodes, stream=None, Dumper=<class 'yaml.dumper.Dumper'>, canonical=None, indent=None, width=None, allow_unicode=None, line_break=None, encoding=None, explicit_start=None, explicit_end=None, version=None, tags=None)
Serialize a sequence of representation trees into a YAML stream.
If stream is None, return the produced string instead.
unsafe_load(stream)
Parse the first YAML document in a stream
and produce the corresponding Python object.
Resolve all tags, even those known to be
unsafe on untrusted input.
unsafe_load_all(stream)
Parse all YAML documents in a stream
and produce corresponding Python objects.
Resolve all tags, even those known to be
unsafe on untrusted input.
warnings(settings=None)
#------------------------------------------------------------------------------
# XXX "Warnings control" is now deprecated. Leaving in the API function to not
# break code that uses it.
#------------------------------------------------------------------------------
DATA
__with_libyaml__ = True
VERSION
6.0.3
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\yaml\__init__.py