Added type hints

Author: adamlui

remove-json-keys/src/remove_json_keys/lib/data/file.py

@@ -1,6 +1,9 @@
-def atomic_write(file_path, data, encoding='utf-8'): # to prevent TOCTOU
+
+from pathlib import Path
+from typing import Union
+
+def atomic_write(file_path: Union[Path, str], data: str, encoding: str ='utf-8') -> None: # to prevent TOCTOU
     import os
-    from pathlib import Path
 
     file_path = Path(file_path)
     file_path.parent.mkdir(parents=True, exist_ok=True)
@@ -14,10 +17,10 @@ def atomic_write(file_path, data, encoding='utf-8'): # to prevent TOCTOU
         if tmp_path.exists() : tmp_path.unlink()
         raise
 
-def read(file_path, encoding='utf-8'):
+def read(file_path: Union[Path, str], encoding: str = 'utf-8') -> str:
     with open(file_path, 'r', encoding=encoding) as file:
         return file.read()
 
-def write(file_path, data, encoding='utf-8'):
+def write(file_path: Union[Path, str], data: str, encoding: str = 'utf-8') -> None:
     with open(file_path, 'w', encoding=encoding) as file:
         file.write(data)

remove-json-keys/src/remove_json_keys/lib/data/json.py

@@ -1,6 +1,6 @@
 import json, re
 from pathlib import Path
-from typing import Any, Dict, Union
+from typing import Any, Dict, List, Union
 
 import json5
 
@@ -13,7 +13,7 @@ def flatten(json: Dict[str, Any], key: str = 'message') -> Dict[str, Any]: # eli
         flat_obj[json_key] = val[key] if isinstance(val, dict) and key in val else val
     return flat_obj
 
-def is_valid(file_path, format='json'):
+def is_valid(file_path: Union[Path, str], format: str = 'json') -> bool:
     file_path = Path(file_path)
     if not file_path.exists():
         return False
@@ -29,14 +29,14 @@ def is_valid(file_path, format='json'):
     else:
         raise ValueError(f"Unsupported format {format!r}. Expected 'json' or 'json5'")
 
-def read(input: Union[str, Path], encoding: str = 'utf-8') -> Any:
+def read(input: Union[Path, str], encoding: str = 'utf-8') -> Any:
     input_str = str(input)
     if input_str.endswith(('.json', '.json5')):
         with open(input_str, 'r', encoding=encoding) as file:
            return json5.load(file)
     else : return json5.loads(input_str)
 
-def remove_keys(json_path, keys):
+def remove_keys(json_path: Path, keys: List[str]):
     keys_removed, keys_skipped, files_processed_cnt = [], [], 0
     for file_path in json_path.rglob('*.json'):
         json_data = file.read(file_path)
@@ -54,7 +54,8 @@ def remove_keys(json_path, keys):
         files_processed_cnt += 1
     return keys_removed, keys_skipped, files_processed_cnt
 
-def write(file_path, data, encoding='utf-8', ensure_ascii=False, style='pretty', atomic=True):
+def write(file_path: Union[Path, str], data: Any, encoding: str = 'utf-8', ensure_ascii: bool = False,
+          style: str = 'pretty', atomic: bool =True):
     Path(file_path).parent.mkdir(parents=True, exist_ok=True)
     if style == 'pretty': # single key/val spans multi-lines
         json_str = json.dumps(data, indent=2, ensure_ascii=ensure_ascii)

remove-json-keys/src/remove_json_keys/lib/data/sns.py

@@ -1,6 +1,7 @@
 from types import SimpleNamespace as sn
+from typing import Any, Dict
 
-def from_dict(obj):
+def from_dict(obj: Dict[str, Any]) -> sn:
     for key, val in obj.items():
         if isinstance(val, dict):
             obj[key] = from_dict(val)

remove-json-keys/src/remove_json_keys/lib/init.py

@@ -1,17 +1,18 @@
 from pathlib import Path
+from types import SimpleNamespace as sn
 
 from . import data, env, jsdelivr, language, log, settings, url
 
 data_path = Path(__file__).parent.parent / 'assets/data'
 
-def cli():
+def cli() -> sn:
     cli = data.sns.from_dict(data.json.read(data_path / 'package_data.json'))
     cli.msgs = language.get_msgs(cli,
         language.generate_random_lang(excludes=['en']) if env.is_debug_mode() else language.get_sys_lang())
     settings.load(cli)
     return cli
 
-def config_file(cli): # for --init
+def config_file(cli: sn) -> None: # for --init
     target_path = Path.cwd() / f'.{cli.short_name}.config.json5'
     project_markers = data.json.read(data_path / 'project_markers.json')
     in_project_root = None
@@ -39,7 +40,7 @@ def config_file(cli): # for --init
     log.success(f'{cli.msgs.log_DEFAULT_CONFIG_CREATED_AT} {target_path}')
     if in_project_root : log.tip(f'{cli.msgs.tip_MOVE_CONFIG_TO_ROOT}.')
 
-def config_filepath(cli): # for settings.load()
+def config_filepath(cli: sn) -> None: # for settings.load()
 
     # Check --config <path>
     if getattr(cli.config, 'config', ''):
@@ -65,7 +66,7 @@ def config_filepath(cli): # for settings.load()
 
     cli.config_filepath = None
 
-def json_path(cli):
+def json_path(cli: sn) -> None:
     for path in Path.cwd().rglob(cli.config.json_dir):
         if path.is_dir():
             cli.json_path = Path(path)

remove-json-keys/src/remove_json_keys/lib/jsdelivr.py

@@ -1,6 +1,9 @@
-def create_pkg_ver_url(cli, version=None):
+from types import SimpleNamespace as sn
+from typing import Optional
+
+def create_pkg_ver_url(cli: sn, version: Optional[str] = None) -> str:
     version = version or cli.version
     return f'{cli.urls.jsdelivr}@{cli.name}-{cli.version}/{cli.name}'
 
-def create_commit_url(cli, hash='latest'):
+def create_commit_url(cli: sn, hash: str = 'latest') -> str:
     return f'{cli.urls.jsdelivr}@{hash}/{cli.name}'

remove-json-keys/src/remove_json_keys/lib/log.py

@@ -1,6 +1,7 @@
 import os, sys
 from pathlib import Path
 from types import SimpleNamespace as sn
+from typing import Dict, List, Optional
 if sys.platform == 'win32' : import colorama ; colorama.init() # enable ANSI color support
 
 from . import data as datalib, pkg, settings
@@ -25,22 +26,24 @@
     gry='\x1b[90m'       # gray
 )
 
-def data(msg, *args, **kwargs) : print(f'\n{colors.bw}{msg.format(*args, **kwargs)}{colors.nc}')
-def dim(msg, *args, **kwargs) : print(f'\n{colors.gry}{msg.format(*args, **kwargs)}{colors.nc}')
-def docs_url(cli) : tip(f'{cli.msgs.tip_FOR_MORE_HELP_VISIT}:\n{cli.urls.docs}')
-def error(msg, *args, **kwargs) : print(f'\n{colors.br}ERROR: {msg.format(*args, **kwargs)}{colors.nc}')
-def help_cmd(cli) : info(f"{cli.msgs.log_TYPE} '{cli.cmds[0]} --help' {cli.msgs.log_FOR_AVAIL_OPTIONS}\n")
-def info(msg, *args, end='', **kwargs) : print(f'\n{colors.by}{msg.format(*args, **kwargs)}{colors.nc}', end=end)
-def init_cmd(cli) : info(f"{cli.msgs.log_TYPE} '{cli.cmds[0]} --init' {cli.msgs.log_TO_CREATE_DEFAULT_CONFIG}\n")
-def overwrite_print(msg, *args, **kwargs):
+def data(msg: str, *args, **kwargs) -> None : print(f'\n{colors.bw}{msg.format(*args, **kwargs)}{colors.nc}')
+def dim(msg: str, *args, **kwargs) -> None : print(f'\n{colors.gry}{msg.format(*args, **kwargs)}{colors.nc}')
+def docs_url(cli: sn) -> None : tip(f'{cli.msgs.tip_FOR_MORE_HELP_VISIT}:\n{cli.urls.docs}')
+def error(msg: str, *args, **kwargs) -> None : print(f'\n{colors.br}ERROR: {msg.format(*args, **kwargs)}{colors.nc}')
+def help_cmd(cli: sn) -> None : info(f"{cli.msgs.log_TYPE} '{cli.cmds[0]} --help' {cli.msgs.log_FOR_AVAIL_OPTIONS}\n")
+def info(msg: str, *args, end: str = '', **kwargs) -> None:
+    print(f'\n{colors.by}{msg.format(*args, **kwargs)}{colors.nc}', end=end)
+def init_cmd(cli: sn) -> None:
+    info(f"{cli.msgs.log_TYPE} '{cli.cmds[0]} --init' {cli.msgs.log_TO_CREATE_DEFAULT_CONFIG}\n")
+def overwrite_print(msg: str, *args, **kwargs) -> None:
     sys.stdout.write('\r' + msg.format(*args, **kwargs).ljust(terminal_width)[:terminal_width])
-def success(msg, *args, **kwargs) : print(f'\n{colors.bg}{msg.format(*args, **kwargs)}{colors.nc}')
-def tip(msg, *args, **kwargs) : print(f'\n{colors.bc}TIP: {msg.format(*args, **kwargs)}{colors.nc}')
-def version(cli):
+def success(msg: str, *args, **kwargs) -> None : print(f'\n{colors.bg}{msg.format(*args, **kwargs)}{colors.nc}')
+def tip(msg: str, *args, **kwargs) -> None : print(f'\n{colors.bc}TIP: {msg.format(*args, **kwargs)}{colors.nc}')
+def version(cli: sn) -> None:
     print(f'\n{colors.by}{cli.name}\n{colors.bw}{cli.msgs.log_VERSION.lower()}: {cli.version}{colors.nc}')
-def warn(msg, *args, **kwargs) : print(f'\n{colors.bo}WARNING: {msg.format(*args, **kwargs)}{colors.nc}')
+def warn(msg: str, *args, **kwargs) -> None : print(f'\n{colors.bo}WARNING: {msg.format(*args, **kwargs)}{colors.nc}')
 
-def warn_legacy_option(cli, flag: str, source: str) -> None:
+def warn_legacy_option(cli: sn, flag: str, source: str) -> None:
     warned_set = _warned_keys[source]
     if flag in warned_set : return
     canonical_key = settings.get_canonical_key(flag)
@@ -62,13 +65,13 @@ def warn_legacy_option(cli, flag: str, source: str) -> None:
     msg += f' {cli.msgs.warn_AND_WILL_BE_REMOVED} @ v{next_maj_ver}'
     warn(msg) ; warned_set.add(flag)
 
-def cmd_docs_url_exit(cli, msg='', cmd='help'):
+def cmd_docs_url_exit(cli: sn, msg: str = '', cmd: str = 'help') -> None:
     if msg : error(msg)
     help_cmd(cli) if cmd == 'help' else init_cmd(cli)
     docs_url(cli)
     sys.exit(1)
 
-def debug(msg, cli=None, *args, **kwargs):
+def debug(msg: str, cli: Optional[sn] = None, *args, **kwargs) -> None:
     if '--debug' not in sys.argv[1:]: return
 
     # Init --debug [target]
@@ -89,7 +92,7 @@ def debug(msg, cli=None, *args, **kwargs):
 
     print(f'\n{colors.by}DEBUG: {msg}{colors.nc}')
 
-def final_summary(msgs, summary_dict):
+def final_summary(msgs: sn, summary_dict: Dict[str, List[str]]) -> None:
     success(f'{msgs.log_ALL_JSON_PROCESSED}!')
     for name, file_set in summary_dict.items():
         if file_set:
@@ -98,7 +101,7 @@ def final_summary(msgs, summary_dict):
             data(f'{msgs.log_KEYS} {status}: {len(file_set)}')
             print(f'{status_color}[\n    ' + '\n    '.join(file_set) + f'\n]{colors.nc}')
 
-def trunc(msg, end='\n'):
+def trunc(msg: str, end: str = '\n') -> None:
     truncated_lines = [
         line if len(line) < terminal_width else line[:terminal_width -4] + '...' for line in msg.splitlines()]
     print('\n'.join(truncated_lines), end=end)

remove-json-keys/src/remove_json_keys/lib/settings.py

@@ -47,7 +47,7 @@ def get_canonical_key(key: str) -> Optional[str]:
 def is_neg_key(key: str) -> bool : 
     return bool(re.match(r'^(?:no|disable|exclude)_', string.removeprefix(key, 'legacy_')))
 
-def load(cli):
+def load(cli: sn) -> None:
     cli.config = sn()
 
     # Assign help tips from cli.msgs

remove-json-keys/src/remove_json_keys/lib/url.py

@@ -1,23 +1,25 @@
+from typing import List, Optional, Tuple
 from urllib.error import URLError
 from urllib.parse import urlparse
 from urllib.request import urlopen
 import webbrowser
 
-def get(url, timeout=5, encoding='utf-8'):
+def get(url: str, timeout: int = 5, encoding: str = 'utf-8') -> str:
     url = validate(url)
     try:
         with urlopen(url, timeout=timeout) as resp:
             return resp.read().decode(encoding)
     except URLError as err:
         raise RuntimeError(f'Failed to fetch from {url}: {err}')
 
-def open(url):
+def open(url: str) -> None:
     url = validate(url)
     try : webbrowser.open(url)
     except Exception as err:
         raise RuntimeError(f'Failed to open {url} in browser browser: {err}')
 
-def validate(url, allowed_schemes=('http', 'https'), allowed_domains=[]):
+def validate(url: str, allowed_schemes: Tuple[str, ...] = ('http', 'https'),
+                       allowed_domains: Optional[List[str]] = None) -> str:
     parsed_url = urlparse(url)
 
     if parsed_url.scheme not in allowed_schemes:

remove-json-keys/src/remove_json_keys/lib/wizard.py

@@ -1,8 +1,9 @@
 import sys
+from types import SimpleNamespace as sn
 
 from . import data, log
 
-def run(cli):
+def run(cli: sn) -> None:
 
     while True: # prompt user for keys to remove
 

translate-messages/src/translate_messages/lib/data/file.py

@@ -1,6 +1,9 @@
-def atomic_write(file_path, data, encoding='utf-8'): # to prevent TOCTOU
+
+from pathlib import Path
+from typing import Union
+
+def atomic_write(file_path: Union[Path, str], data: str, encoding: str ='utf-8') -> None: # to prevent TOCTOU
     import os
-    from pathlib import Path
 
     file_path = Path(file_path)
     file_path.parent.mkdir(parents=True, exist_ok=True)
@@ -14,10 +17,10 @@ def atomic_write(file_path, data, encoding='utf-8'): # to prevent TOCTOU
         if tmp_path.exists() : tmp_path.unlink()
         raise
 
-def read(file_path, encoding='utf-8'):
+def read(file_path: Union[Path, str], encoding: str = 'utf-8') -> str:
     with open(file_path, 'r', encoding=encoding) as file:
         return file.read()
 
-def write(file_path, data, encoding='utf-8'):
+def write(file_path: Union[Path, str], data: str, encoding: str = 'utf-8') -> None:
     with open(file_path, 'w', encoding=encoding) as file:
         file.write(data)