src.lib.actions.secrets.Secrets Class Reference

Collaboration diagram for src.lib.actions.secrets.Secrets:

Public Member Functions
None	__init__ (self, int success=0, int error=84, bool debug=False)
Dict[str, Any]	get_secret (self, str secret_name)
None	set_token (self, str token)
str	get_token (self)
str	get_bearer (self)

Static Public Member Functions
str	now ()
str	current_date ()
str	current_time ()
str	now_utc ()
str	current_date_utc ()
str	current_time_utc ()
str	now_server ()
str	current_date_server ()
str	current_time_server ()

Data Fields
bool	debug = debug
int	success = success
int	error = error
str	scope = "secrets"
Variables	vars

Detailed Description

_summary_
This class is in charge of storing the secrets for the server.

Definition at line 10 of file secrets.py.

Constructor & Destructor Documentation

__init__()

None src.lib.actions.secrets.Secrets.__init__	(		self,
		int	success = 0,
		int	error = 84,
		bool	debug = False )

_summary_
    Class in charge of managing the secrets for the server runtime trigger and consequences.

Args:
    success (int, optional): _description_. Defaults to 0.
    error (int, optional): _description_. Defaults to 84.
    debug (bool, optional): _description_. Defaults to False.

Definition at line 15 of file secrets.py.

Member Function Documentation

current_date()

str src.lib.actions.secrets.Secrets.current_date ( )

static

_summary_
    $ref{secrets.current_date}: Returns the current date without the time in the server's local timezone

Returns:
    _type_: _description_

Definition at line 84 of file secrets.py.

current_date_server()

str src.lib.actions.secrets.Secrets.current_date_server ( )

static

_summary_
    $ref{secrets.current_date_server}: Returns the current date without the time in the server's local timezone

Returns:
    _type_: _description_

Definition at line 144 of file secrets.py.

current_date_utc()

str src.lib.actions.secrets.Secrets.current_date_utc ( )

static

_summary_
    $ref{secrets.current_date_utc}: Returns the current date without the time in UTC

Returns:
    _type_: _description_

Definition at line 114 of file secrets.py.

current_time()

str src.lib.actions.secrets.Secrets.current_time ( )

static

_summary_
    $ref{secrets.current_time}: Returns the current time (hours:minutes:seconds) in the server's local timezone

Returns:
    _type_: _description_

Definition at line 94 of file secrets.py.

current_time_server()

str src.lib.actions.secrets.Secrets.current_time_server ( )

static

_summary_
    $ref{secrets.current_time_server}: Returns the current time (hours:minutes:seconds) in the server's local timezone

Returns:
    _type_: _description_

Definition at line 154 of file secrets.py.

current_time_utc()

str src.lib.actions.secrets.Secrets.current_time_utc ( )

static

_summary_
    $ref{secrets.current_time_utc}: Returns the current time (hours:minutes:seconds) in UTC

Returns:
    _type_: _description_

Definition at line 124 of file secrets.py.

get_bearer()

str src.lib.actions.secrets.Secrets.get_bearer

(

self

)

_summary_
    Get the bearer for the server.

Returns:
    str: _description_

Definition at line 67 of file secrets.py.

get_secret()

Dict[str, Any] src.lib.actions.secrets.Secrets.get_secret	(		self,
		str	secret_name )

_summary_
    Get the secret from the server.

Args:
    secret_name (str): _description_

Returns:
    Dict[str, Any]: _description_

Definition at line 35 of file secrets.py.

get_token()

str src.lib.actions.secrets.Secrets.get_token

(

self

)

_summary_
    Get the token for the server.

Returns:
    str: _description_

Definition at line 58 of file secrets.py.

now()

str src.lib.actions.secrets.Secrets.now ( )

static

_summary_
Get the current time.

Definition at line 77 of file secrets.py.

now_server()

str src.lib.actions.secrets.Secrets.now_server ( )

static

_summary_
    $ref{secrets.now_server}: Returns the current datetime with timezone info in the server's local timezone

Returns:
    _type_: _description_

Definition at line 134 of file secrets.py.

now_utc()

str src.lib.actions.secrets.Secrets.now_utc ( )

static

_summary_
    $ref{secrets.now_utc}: Returns the current datetime in UTC with timezone info

Returns:
    _type_: _description_

Definition at line 104 of file secrets.py.

set_token()

None src.lib.actions.secrets.Secrets.set_token	(		self,
		str	token )

_summary_
    Set the token for the server.

Args:
    token (str): _description_

Definition at line 47 of file secrets.py.

Field Documentation

debug

bool src.lib.actions.secrets.Secrets.debug = debug

Definition at line 24 of file secrets.py.

error

int src.lib.actions.secrets.Secrets.error = error

Definition at line 26 of file secrets.py.

scope

src.lib.actions.secrets.Secrets.scope = "secrets"

Definition at line 27 of file secrets.py.

success

int src.lib.actions.secrets.Secrets.success = success

Definition at line 25 of file secrets.py.

vars

Variables src.lib.actions.secrets.Secrets.vars

Initial value:

=  Variables(
            success=self.success,
            error=self.error,
            debug=self.debug
        )

Definition at line 29 of file secrets.py.

---

The documentation for this class was generated from the following file:

• app/back/server/src/lib/actions/secrets.py