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

type annotation updates

Browse Source
This commit is contained in:
Kelly Brazil
2022-02-01 17:54:22 -08:00
parent 96ec70de4f
commit 21719f9a26
2 changed files with 18 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
jc/lib.py
View File

@ -225,7 +225,7 @@ def plugin_parser_mod_list() -> List[str]:
"""
return [_cliname_to_modname(p) for p in local_parsers]
def parser_info(parser_mod_name: str) -> Union[Dict, None]:
def parser_info(parser_mod_name: str) -> Optional[Dict]:
"""
Returns a dictionary that includes the module metadata.

36
jc/utils.py
View File

@ -5,7 +5,7 @@ import locale
import shutil
from datetime import datetime, timezone
from textwrap import TextWrapper
from typing import Dict, Iterable, List, Union
from typing import Dict, Iterable, List, Union, Optional
def warning_message(message_lines: List[str]) -> None:
@ -127,7 +127,7 @@ def has_data(data: str) -> bool:
return bool(data and not data.isspace())
def convert_to_int(value: Union[str, float]) -> Union[int, None]:
def convert_to_int(value: Union[str, float]) -> Optional[int]:
"""
Converts string and float input to int. Strips all non-numeric
characters from strings.
@ -157,7 +157,7 @@ def convert_to_int(value: Union[str, float]) -> Union[int, None]:
return None
def convert_to_float(value: Union[str, int]) -> Union[float, None]:
def convert_to_float(value: Union[str, int]) -> Optional[float]:
"""
Converts string and int input to float. Strips all non-numeric
characters from strings.
@ -277,23 +277,21 @@ class timestamp:
Parameters:
datetime_string: (str) a string representation of a
date-time in several supported formats
datetime_string (str): a string representation of a
datetime in several supported formats
Attributes:
Returns a timestamp object with the following attributes:
string (str) the input datetime string
string (str): the input datetime string
format (int) the format rule that was used to
decode the datetime string. None if
conversion fails
format (int | None): the format rule that was used to decode
the datetime string. None if conversion fails.
naive (int) timestamp based on locally configured
timezone. None if conversion fails
naive (int | None): timestamp based on locally configured
timezone. None if conversion fails.
utc (int) aware timestamp only if UTC timezone
detected in datetime string. None if
conversion fails
utc (int | None) aware timestamp only if UTC timezone
detected in datetime string. None if conversion fails.
"""
self.string = datetime_string
dt = self._parse()
@ -316,19 +314,19 @@ class timestamp:
Returns:
Dictionary A Dictionary of the following format:
Dictionary of the following format:
{
# for debugging purposes. None if conversion fails
"format": integer,
"format": int,
# timestamp based on locally configured timezone.
# None if conversion fails.
"timestamp_naive": integer,
"timestamp_naive": int,
# aware timestamp only if UTC timezone detected.
# None if conversion fails.
"timestamp_utc": integer
"timestamp_utc": int
}
The `format` integer denotes which date_time format