OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 19:26:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update scan-missing-env-vars.py

Browse Source 
update to work on Windows + some exception catches
This commit is contained in:
Silentoplayz 2024-12-22 14:14:07 -05:00
parent a1fb0ff5bf
commit 653234d479
1 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
scripts/scan-missing-env-vars.py
View File

@ -66,12 +66,16 @@ def main():
all_env_vars = set() all_env_vars = set()
for url, filename in zip(urls, filenames): try:
with urllib.request.urlopen(url) as response: for url, filename in zip(urls, filenames):
contents = response.read().decode("utf-8") with urllib.request.urlopen(url) as response:
contents = response.read().decode("utf-8")
for env_var in find_env_vars(contents): for env_var in find_env_vars(contents):
all_env_vars.add(env_var) all_env_vars.add(env_var)
except urllib.error.URLError as e:
print(f"Failed to open URL: {e}")
sys.exit(1)
ignored_env_vars = { ignored_env_vars = {
"FROM_INIT_PY", "FROM_INIT_PY",
@ -86,29 +90,33 @@ def main():
documented_env_vars = set() documented_env_vars = set()
script_dir = os.path.dirname(os.path.abspath(__file__)) script_dir = os.path.dirname(os.path.abspath(__file__))
docs_file = os.path.join( docs_file = os.path.join(
script_dir, "..", "docs", "getting-started", "env-configuration.md" script_dir, *[part for part in ["..", "docs", "getting-started", "advanced-topics", "env-configuration.md"]]
) )
with open(docs_file, "r") as f:
for line in f: try:
if line.startswith("#### `"): with open(docs_file, "r", encoding="utf-8", errors="ignore") as f:
env_var = line.split("`")[1] for line in f:
documented_env_vars.add(env_var) if line.startswith("#### `"):
env_var = line.split("`")[1]
documented_env_vars.add(env_var)
except FileNotFoundError as e:
print(f"Failed to open file: {e}")
sys.exit(1)
print("\nEnvironment variables accessed but not documented:") print("\nEnvironment variables accessed but not documented:")
if all_env_vars - documented_env_vars: not_documented_env_vars = all_env_vars - documented_env_vars - ignored_env_vars
for env_var in sorted(all_env_vars - documented_env_vars - ignored_env_vars): for env_var in sorted(not_documented_env_vars):
print(env_var) print(env_var)
else: if not not_documented_env_vars:
print("None") print("None")
print("\nEnvironment variables documented but not accessed:") print("\nEnvironment variables documented but not accessed:")
diff = documented_env_vars - all_env_vars - ignored_env_vars diff = documented_env_vars - all_env_vars - ignored_env_vars
if diff: for env_var in sorted(diff):
for env_var in sorted(diff): print(env_var)
print(env_var) if not diff:
else:
print("None") print("None")
if __name__ == "__main__": if __name__ == "__main__":
main() main()