Refactor

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `IPv4API.IDENTME` renamed to `IPv4API.IDENT_ME`
 - `IPv4API.TNEDIME` renamed to `IPv4API.TNEDI_ME`
 - `get_public_ipv4` function modified
+- `filter_parameter` function renamed to `_filter_parameter`
 - `README.md` updated
 ## [0.3] - 2025-05-19
 ### Added

ipspot/cli.py

@@ -4,7 +4,7 @@
 from typing import Union, Tuple
 from art import tprint
 from .ipv4 import get_public_ipv4, get_private_ipv4
-from .utils import filter_parameter
+from .utils import _filter_parameter
 from .params import IPv4API, PARAMETERS_NAME_MAP
 from .params import IPSPOT_OVERVIEW, IPSPOT_REPO, IPSPOT_VERSION
 
@@ -42,7 +42,7 @@ def display_ip_info(ipv4_api: IPv4API = IPv4API.AUTO_SAFE, geo: bool=False,
             print(
                 "  {name}: {parameter}".format(
                     name=PARAMETERS_NAME_MAP[name],
-                    parameter=filter_parameter(parameter)))
+                    parameter=_filter_parameter(parameter)))
     else:
         print("  Error: {public_result[error]}".format(public_result=public_result))
 

ipspot/utils.py

@@ -19,7 +19,7 @@ def is_loopback(ip: str) -> bool:
         return False
 
 
-def filter_parameter(parameter: Any) -> Any:
+def _filter_parameter(parameter: Any) -> Any:
     """
     Filter input parameter.
 

tests/test_utils.py

@@ -1,22 +1,22 @@
-from ipspot.utils import filter_parameter
+from ipspot.utils import _filter_parameter
 
 TEST_CASE_NAME = "Utils tests"
 
 
 def test_filter_parameter1():
-    assert filter_parameter(None) == "N/A"
+    assert _filter_parameter(None) == "N/A"
 
 
 def test_filter_parameter2():
-    assert filter_parameter("") == "N/A"
+    assert _filter_parameter("") == "N/A"
 
 
 def test_filter_parameter3():
-    assert filter_parameter("   ") == "N/A"
+    assert _filter_parameter("   ") == "N/A"
 
 
 def test_filter_parameter4():
-    assert filter_parameter("GB") == "GB"
+    assert _filter_parameter("GB") == "GB"