make constants and utils private

Author: Artem Krivonos

awslambdaric/bootstrap.py

@@ -15,20 +15,20 @@
 from .lambda_runtime_exception import FaultException
 from .lambda_runtime_log_utils import (
     JsonFormatter,
-    DATETIME_FORMAT,
-    JSON_FORMAT,
-    TEXT_FORMAT,
-    get_log_format_from_str,
+    _DATETIME_FORMAT,
+    _JSON_FORMAT,
+    _TEXT_FORMAT,
+    _get_log_format_from_str,
 )
 from .lambda_runtime_marshaller import to_json
 
 ERROR_LOG_LINE_TERMINATE = "\r"
 ERROR_LOG_IDENT = "\u00a0"  # NO-BREAK SPACE U+00A0
 RUNTIME_ERROR_LOGGER_NAME = "system"
-AWS_LAMBDA_LOG_FORMAT = get_log_format_from_str(
+_AWS_LAMBDA_LOG_FORMAT = _get_log_format_from_str(
     os.environ.get("AWS_LAMBDA_LOG_FORMAT", "TEXT").upper()
 )
-AWS_LAMBDA_LOG_LEVEL = os.environ.get("AWS_LAMBDA_LOG_LEVEL")
+_AWS_LAMBDA_LOG_LEVEL = os.environ.get("AWS_LAMBDA_LOG_LEVEL")
 
 
 def _get_handler(handler):
@@ -90,7 +90,7 @@ def make_error(
 ):
     result = {
         "timestamp": time.strftime(
-            DATETIME_FORMAT, logging.Formatter.converter(time.time())
+            _DATETIME_FORMAT, logging.Formatter.converter(time.time())
         ),
         "log_level": level,
         "logger": RUNTIME_ERROR_LOGGER_NAME,
@@ -152,7 +152,7 @@ def log_error_text(error_result, log_sink):
     )
 
 
-if AWS_LAMBDA_LOG_FORMAT == JSON_FORMAT:
+if _AWS_LAMBDA_LOG_FORMAT == _JSON_FORMAT:
     log_error = log_error_json
 else:
     log_error = log_error_text
@@ -302,7 +302,7 @@ def emit(self, record):
         self.log_sink.log(
             msg,
             log_level=record.levelno,
-            log_format=getattr(record, "log_format", TEXT_FORMAT),
+            log_format=getattr(record, "log_format", _TEXT_FORMAT),
         )
 
 
@@ -353,18 +353,18 @@ def log_error(self, message_lines, log_level=logging.ERROR):
 
 
 FRAME_TYPES = {
-    (JSON_FORMAT, logging.NOTSET): 0xA55A0002.to_bytes(4, "big"),
-    (JSON_FORMAT, logging.DEBUG): 0xA55A000A.to_bytes(4, "big"),
-    (JSON_FORMAT, logging.INFO): 0xA55A000E.to_bytes(4, "big"),
-    (JSON_FORMAT, logging.WARNING): 0xA55A0012.to_bytes(4, "big"),
-    (JSON_FORMAT, logging.ERROR): 0xA55A0016.to_bytes(4, "big"),
-    (JSON_FORMAT, logging.CRITICAL): 0xA55A001A.to_bytes(4, "big"),
-    (TEXT_FORMAT, logging.NOTSET): 0xA55A0003.to_bytes(4, "big"),
-    (TEXT_FORMAT, logging.DEBUG): 0xA55A000B.to_bytes(4, "big"),
-    (TEXT_FORMAT, logging.INFO): 0xA55A000F.to_bytes(4, "big"),
-    (TEXT_FORMAT, logging.WARNING): 0xA55A0013.to_bytes(4, "big"),
-    (TEXT_FORMAT, logging.ERROR): 0xA55A0017.to_bytes(4, "big"),
-    (TEXT_FORMAT, logging.CRITICAL): 0xA55A001B.to_bytes(4, "big"),
+    (_JSON_FORMAT, logging.NOTSET): 0xA55A0002.to_bytes(4, "big"),
+    (_JSON_FORMAT, logging.DEBUG): 0xA55A000A.to_bytes(4, "big"),
+    (_JSON_FORMAT, logging.INFO): 0xA55A000E.to_bytes(4, "big"),
+    (_JSON_FORMAT, logging.WARNING): 0xA55A0012.to_bytes(4, "big"),
+    (_JSON_FORMAT, logging.ERROR): 0xA55A0016.to_bytes(4, "big"),
+    (_JSON_FORMAT, logging.CRITICAL): 0xA55A001A.to_bytes(4, "big"),
+    (_TEXT_FORMAT, logging.NOTSET): 0xA55A0003.to_bytes(4, "big"),
+    (_TEXT_FORMAT, logging.DEBUG): 0xA55A000B.to_bytes(4, "big"),
+    (_TEXT_FORMAT, logging.INFO): 0xA55A000F.to_bytes(4, "big"),
+    (_TEXT_FORMAT, logging.WARNING): 0xA55A0013.to_bytes(4, "big"),
+    (_TEXT_FORMAT, logging.ERROR): 0xA55A0017.to_bytes(4, "big"),
+    (_TEXT_FORMAT, logging.CRITICAL): 0xA55A001B.to_bytes(4, "big"),
 }
 DEFAULT_FRAME_TYPE = 0xA55A0003.to_bytes(4, "big")
 
@@ -395,7 +395,7 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, exc_tb):
         self.file.close()
 
-    def log(self, msg, log_level=logging.NOTSET, log_format: int = TEXT_FORMAT):
+    def log(self, msg, log_level=logging.NOTSET, log_format: int = _TEXT_FORMAT):
         frame_type = FRAME_TYPES.get((log_format, log_level), DEFAULT_FRAME_TYPE)
         encoded_msg = msg.encode("utf8")
 
@@ -439,7 +439,7 @@ def setup_logging(log_format, log_level, log_sink):
     logging.Formatter.converter = time.gmtime
     logger = logging.getLogger()
     logger_handler = LambdaLoggerHandler(log_sink)
-    if log_format == JSON_FORMAT:
+    if log_format == _JSON_FORMAT:
         logger_handler.setFormatter(JsonFormatter())
     else:
         logger_handler.setFormatter(
@@ -464,7 +464,7 @@ def run(app_root, handler, lambda_runtime_api_addr):
         lambda_runtime_client = LambdaRuntimeClient(lambda_runtime_api_addr)
 
         try:
-            setup_logging(AWS_LAMBDA_LOG_FORMAT, AWS_LAMBDA_LOG_LEVEL, log_sink)
+            setup_logging(_AWS_LAMBDA_LOG_FORMAT, _AWS_LAMBDA_LOG_LEVEL, log_sink)
             global _GLOBAL_AWS_REQUEST_ID
 
             request_handler = _get_handler(handler)

awslambdaric/lambda_runtime_log_utils.py

@@ -7,8 +7,8 @@
 
 from .lambda_runtime_marshaller import to_json
 
-DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
-RESERVED_FIELDS = {
+_DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+_RESERVED_FIELDS = {
     "name",
     "msg",
     "args",
@@ -32,19 +32,19 @@
     "aws_request_id",
     "log_format",
 }
-JSON_FORMAT = 0b0
-TEXT_FORMAT = 0b1
+_JSON_FORMAT = 0b0
+_TEXT_FORMAT = 0b1
 
 
-def get_log_format_from_str(value: str):
+def _get_log_format_from_str(value: str):
     if value == "JSON":
-        return JSON_FORMAT
-    return TEXT_FORMAT
+        return _JSON_FORMAT
+    return _TEXT_FORMAT
 
 
 class JsonFormatter(logging.Formatter):
     def __init__(self):
-        super().__init__(datefmt=DATETIME_FORMAT, validate=False)
+        super().__init__(datefmt=_DATETIME_FORMAT, validate=False)
 
     @staticmethod
     def format_stacktrace(exc_info):
@@ -80,7 +80,7 @@ def format_log_level(record: logging.LogRecord):
 
     def format(self, record: logging.LogRecord) -> str:
         self.format_log_level(record)
-        record.log_format = JSON_FORMAT
+        record.log_format = _JSON_FORMAT
 
         result = {
             "timestamp": self.formatTime(record, self.datefmt),
@@ -96,7 +96,7 @@ def format(self, record: logging.LogRecord) -> str:
         result.update(
             (key, value)
             for key, value in record.__dict__.items()
-            if key not in RESERVED_FIELDS and key not in result
+            if key not in _RESERVED_FIELDS and key not in result
         )
 
         result = {k: v for k, v in result.items() if v is not None}

tests/test_bootstrap.py

@@ -20,9 +20,9 @@
 from awslambdaric.lambda_runtime_exception import FaultException
 from awslambdaric.lambda_runtime_marshaller import LambdaMarshaller
 from awslambdaric.lambda_runtime_log_utils import (
-    JSON_FORMAT,
-    TEXT_FORMAT,
-    get_log_format_from_str,
+    _JSON_FORMAT,
+    _TEXT_FORMAT,
+    _get_log_format_from_str,
 )
 
 
@@ -1146,8 +1146,8 @@ def test_log_level_frame_type(self):
 
     def test_log_format_frame_type(self):
         test_cases = [
-            (TEXT_FORMAT, 0xA55A0003),
-            (JSON_FORMAT, 0xA55A0002),
+            (_TEXT_FORMAT, 0xA55A0003),
+            (_JSON_FORMAT, 0xA55A0002),
         ]
 
         for fmt, expected_frame_type in test_cases:
@@ -1228,7 +1228,7 @@ class TestLogging(unittest.TestCase):
     @classmethod
     def setUpClass(cls) -> None:
         bootstrap.setup_logging(
-            get_log_format_from_str("JSON"), "INFO", bootstrap.StandardLogSink()
+            _get_log_format_from_str("JSON"), "INFO", bootstrap.StandardLogSink()
         )
 
     @patch("sys.stderr", new_callable=StringIO)