Hugging Face's logo

Spaces:
Alibrown
/
ZeroGPU-Mini-Trainer
Running on Zero

App Files Community
Alibrown commited on
Commit
404db42
·
verified ·
1 Parent(s): b74fa21

Delete PyFundaments – Function Overview.md

Browse files
Files changed (1) hide show
  1. PyFundaments – Function Overview.md +0 -145
PyFundaments – Function Overview.md DELETED
@@ -1,145 +0,0 @@
1
- # PyFundaments – Function Overview
2
-
3
- ## `main.py`
4
-
5
- | Function | Description |
6
- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
7
- | `initialize_fundaments()` | Asynchronously initializes services based on available environment variables. Returns a dictionary of services (`None` if not initialized). |
8
- | `main()` | Application entry point. Calls `initialize_fundaments()`, loads `app/app.py`, closes DB pool on shutdown. |
9
-
10
- ---
11
-
12
- ## `fundaments/config_handler.py` – `ConfigHandler`
13
-
14
- | Function | Description |
15
- | ------------------------ | ------------------------------------------------------------------ |
16
- | `__init__()` | Loads `.env` via `python-dotenv` and system environment variables. |
17
- | `load_all_config()` | Stores all non-empty environment variables in `self.config`. |
18
- | `get(key)` | Returns value as string or `None`. |
19
- | `get_bool(key, default)` | Parses boolean values (`true/1/yes/on`). |
20
- | `get_int(key, default)` | Returns integer value or `default` on failure. |
21
- | `has(key)` | Returns `True` if key exists and is not empty. |
22
- | `get_all()` | Returns copy of full configuration dictionary. |
23
- | `config_service` | Global singleton instance. |
24
-
25
- ---
26
-
27
- ## `fundaments/postgresql.py`
28
-
29
- | Function | Description |
30
- | ----------------------------------------------------- | ----------------------------------------------------------------------------------- |
31
- | `enforce_cloud_security(dsn_url)` | Enforces `sslmode=require`, applies timeouts, removes incompatible DSN options. |
32
- | `mask_dsn(dsn_url)` | Removes credentials from DSN for logging. |
33
- | `ssl_runtime_check(conn)` | Verifies active SSL connection. |
34
- | `init_db_pool(dsn_url)` | Creates asyncpg pool (min=1, max=10) and runs SSL check. |
35
- | `close_db_pool()` | Gracefully closes connection pool. |
36
- | `execute_secured_query(query, *params, fetch_method)` | Executes parameterized query (`fetch`, `fetchrow`, `execute`) with reconnect logic. |
37
-
38
- ---
39
-
40
- ## `fundaments/encryption.py` – `Encryption`
41
-
42
- | Function | Description |
43
- | -------------------------------------- | ---------------------------------------------------------------- |
44
- | `generate_salt()` | Generates secure 16-byte hex salt. |
45
- | `__init__(master_key, salt)` | Derives AES-256 key via PBKDF2-SHA256 (480k iterations). |
46
- | `encrypt(data)` | Encrypts string using AES-256-GCM. Returns `{data, nonce, tag}`. |
47
- | `decrypt(encrypted_data, nonce, tag)` | Decrypts data. Raises `InvalidTag` if tampered. |
48
- | `encrypt_file(source_path, dest_path)` | Encrypts file in 8192-byte chunks. |
49
- | `decrypt_file(source_path, dest_path)` | Decrypts file using stored nonce and tag. |
50
-
51
- ---
52
-
53
- ## `fundaments/access_control.py` – `AccessControl`
54
-
55
- | Function | Description |
56
- | -------------------------------------------------- | ------------------------------------ |
57
- | `__init__(user_id)` | Initializes with optional user ID. |
58
- | `has_permission(permission_name)` | Checks if user has permission. |
59
- | `get_user_permissions()` | Returns all user permissions. |
60
- | `get_user_roles()` | Returns assigned roles. |
61
- | `assign_role(role_id)` | Assigns role to user. |
62
- | `remove_role(role_id)` | Removes role from user. |
63
- | `get_all_roles()` | Returns all roles. |
64
- | `get_all_permissions()` | Returns all permissions. |
65
- | `create_role(name, description)` | Creates new role and returns ID. |
66
- | `update_role_permissions(role_id, permission_ids)` | Replaces all permissions for a role. |
67
- | `get_role_permissions(role_id)` | Returns role permissions. |
68
-
69
- ---
70
-
71
- ## `fundaments/user_handler.py`
72
-
73
- ### `Database` (SQLite Wrapper)
74
-
75
- | Function | Description |
76
- | ------------------------- | ------------------------------------------------- |
77
- | `execute(query, params)` | Executes query and commits. |
78
- | `fetchone(query, params)` | Returns single row. |
79
- | `fetchall(query, params)` | Returns all rows. |
80
- | `close()` | Closes connection. |
81
- | `setup_tables()` | Creates `users` and `sessions` tables if missing. |
82
-
83
- ---
84
-
85
- ### `Security` (Password Utilities)
86
-
87
- | Function | Description |
88
- | ----------------------------------- | -------------------------------------------- |
89
- | `hash_password(password)` | Hashes password (PBKDF2-SHA256 via passlib). |
90
- | `verify_password(password, hashed)` | Verifies password against hash. |
91
- | `regenerate_session(session_id)` | Generates new UUID session ID. |
92
-
93
- ---
94
-
95
- ### `UserHandler`
96
-
97
- | Function | Description |
98
- | ----------------------------------------- | ------------------------------------------------------ |
99
- | `login(username, password, request_data)` | Authenticates user, validates state, creates session. |
100
- | `logout()` | Removes session from DB and memory. |
101
- | `is_logged_in()` | Checks if active session exists. |
102
- | `is_admin()` | Checks session `is_admin` flag. |
103
- | `validate_session(request_data)` | Validates session against IP and User-Agent. |
104
- | `lock_account(username)` | Locks user account. |
105
- | `reset_failed_attempts(username)` | Resets failed login counter. |
106
- | `increment_failed_attempts(username)` | Increments failed attempts and locks after 5 failures. |
107
-
108
- ---
109
-
110
- ## `fundaments/security.py` – `Security` (Orchestrator)
111
-
112
- | Function | Description |
113
- | ---------------------------------------------- | --------------------------------------------------------------------- |
114
- | `__init__(services)` | Initializes with required services. Raises `RuntimeError` if missing. |
115
- | `user_login(username, password, request_data)` | Performs login and session validation. |
116
- | `check_permission(user_id, permission_name)` | Delegates permission check. |
117
- | `encrypt_data(data)` | Encrypts data if encryption service is available. |
118
- | `decrypt_data(encrypted_data, nonce, tag)` | Decrypts data or returns `None` on failure. |
119
-
120
- ---
121
-
122
- ## `fundaments/debug.py` – `PyFundamentsDebug`
123
-
124
- | Function | Description |
125
- | ----------------- | ------------------------------------------------------- |
126
- | `__init__()` | Reads debug-related environment variables. |
127
- | `_setup_logger()` | Configures logging handlers. |
128
- | `run()` | Outputs runtime diagnostics when debug mode is enabled. |
129
-
130
- ---
131
-
132
- ## `app/app.py`
133
-
134
- | Function | Description |
135
- | ------------------------------- | --------------------------------------------------------------------- |
136
- | `start_application(fundaments)` | Receives initialized service dictionary and starts application logic. |
137
-
138
- ---
139
-
140
- ## Architecture Notes
141
-
142
- * `UserHandler` uses internal SQLite.
143
- * `AccessControl` uses PostgreSQL via `execute_secured_query`.
144
- * `security.py` `Security` is the orchestrator layer.
145
- * All services are optional.