python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-19 00:17:51 +02:00
Code Issues Releases Activity

add more type annotations

Browse Source
This commit is contained in:
Kelly Brazil
2022-10-14 13:38:05 -07:00
parent a53f2ecbaf
commit 95ba628ac3
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
jc/lib.py
View File

@ -4,11 +4,12 @@ import os
import re import re
import importlib import importlib
from typing import Dict, List, Iterable, Union, Iterator from typing import Dict, List, Iterable, Union, Iterator
from types import ModuleType
from jc import appdirs from jc import appdirs
__version__ = '1.22.1' __version__ = '1.22.1'
parsers = [ parsers: List = [
'acpi', 'acpi',
'airport', 'airport',
'airport-s', 'airport-s',
@ -185,11 +186,11 @@ parsers = [
'zipinfo' 'zipinfo'
] ]
def _cliname_to_modname(parser_cli_name): def _cliname_to_modname(parser_cli_name: str) -> str:
"""Return real module name (dashes converted to underscores)""" """Return real module name (dashes converted to underscores)"""
return parser_cli_name.replace('--', '').replace('-', '_') return parser_cli_name.replace('--', '').replace('-', '_')
def _modname_to_cliname(parser_mod_name): def _modname_to_cliname(parser_mod_name: str) -> str:
"""Return module's cli name (underscores converted to dashes)""" """Return module's cli name (underscores converted to dashes)"""
return parser_mod_name.replace('_', '-') return parser_mod_name.replace('_', '-')
@ -212,12 +213,12 @@ if os.path.isdir(local_parsers_dir):
except Exception: except Exception:
pass pass
def _parser_argument(parser_mod_name): def _parser_argument(parser_mod_name:str) -> str:
"""Return short name of the parser with dashes and with -- prefix""" """Return short name of the parser with dashes and with -- prefix"""
parser = _modname_to_cliname(parser_mod_name) parser = _modname_to_cliname(parser_mod_name)
return f'--{parser}' return f'--{parser}'
def _get_parser(parser_mod_name): def _get_parser(parser_mod_name: str) -> ModuleType:
"""Return the parser module object""" """Return the parser module object"""
# ensure parser_mod_name is a true module name and not a cli name # ensure parser_mod_name is a true module name and not a cli name
parser_mod_name = _cliname_to_modname(parser_mod_name) parser_mod_name = _cliname_to_modname(parser_mod_name)
@ -226,7 +227,7 @@ def _get_parser(parser_mod_name):
modpath = 'jcparsers.' if parser_cli_name in local_parsers else 'jc.parsers.' modpath = 'jcparsers.' if parser_cli_name in local_parsers else 'jc.parsers.'
return importlib.import_module(f'{modpath}{parser_mod_name}') return importlib.import_module(f'{modpath}{parser_mod_name}')
def _parser_is_streaming(parser): def _parser_is_streaming(parser: ModuleType) -> bool:
""" """
Returns True if this is a streaming parser, else False Returns True if this is a streaming parser, else False
@ -237,7 +238,7 @@ def _parser_is_streaming(parser):
return False return False
def _parser_is_hidden(parser): def _parser_is_hidden(parser: ModuleType) -> bool:
""" """
Returns True if this is a hidden parser, else False Returns True if this is a hidden parser, else False
@ -248,7 +249,7 @@ def _parser_is_hidden(parser):
return False return False
def _parser_is_deprecated(parser): def _parser_is_deprecated(parser: ModuleType) -> bool:
""" """
Returns True if this is a deprecated parser, else False Returns True if this is a deprecated parser, else False