slack-api-sdk-apimatic 1.1.1__py3-none-any.whl

slackwebapi/logging/configuration/api_logging_configuration.py

@@ -0,0 +1,398 @@
+
+"""
+slackwebapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+import logging
+import os
+
+from apimatic_core.logger.configuration.api_logging_configuration import (
+    ApiLoggingConfiguration,
+    ApiRequestLoggingConfiguration,
+    ApiResponseLoggingConfiguration,
+)
+
+
+class RequestLoggingConfiguration(ApiRequestLoggingConfiguration):
+    """
+    Configuration for controlling how API request details are logged.
+    Provides options to include or exclude data such as headers, query
+    parameters and request body to support flexible logging behavior.
+    """
+
+    def __init__(self, log_body=False, log_headers=False, headers_to_include=None,
+                 headers_to_exclude=None, headers_to_unmask=None,
+                 include_query_in_path=False):
+        """
+        Initialize the Request Logging Configuration.
+
+        Args:
+            log_body (bool): Controls the logging of the request body.
+            log_headers (bool): Controls the logging of request headers.
+            headers_to_include (List[str]): Includes only specified headers in
+             the log output.
+            headers_to_exclude (List[str]): Excludes specified headers from
+             the log output.
+            headers_to_unmask (List[str]): Logs specified headers without masking,
+             revealing their actual values.
+            include_query_in_path (bool): Determines whether to include query
+             parameters in the logged request path.
+
+        """
+        super().__init__(
+            log_body,
+            log_headers,
+            headers_to_include,
+            headers_to_exclude,
+            headers_to_unmask,
+            include_query_in_path,
+        )
+
+    def clone_with(self, log_body=None, log_headers=None,
+                   headers_to_include=None, headers_to_exclude=None,
+                   headers_to_unmask=None, include_query_in_path=False):
+        """
+        Create a copy of this configuration with overridden attributes.
+
+        Args:
+            log_body (bool): Optional override for logging the body.
+            log_headers (bool): Optional override for logging headers.
+            headers_to_include (List[str]): Optional override for included headers.
+            headers_to_exclude (List[str]): Optional override for excluded headers.
+            headers_to_unmask (List[str]): Optional override for unmasked headers.
+            include_query_in_path (bool): Optional override for including queries.
+
+        Returns:
+            RequestLoggingConfiguration: A new configuration instance.
+
+        """
+        log_body = log_body or self.log_body
+        log_headers = log_headers or self.log_headers
+        headers_to_include = headers_to_include or self.headers_to_include
+        headers_to_exclude = headers_to_exclude or self.headers_to_exclude
+        headers_to_unmask = headers_to_unmask or self.headers_to_unmask
+        include_query_in_path = include_query_in_path or self.include_query_in_path
+
+        return RequestLoggingConfiguration(
+            log_body,
+            log_headers,
+            headers_to_include,
+            headers_to_exclude,
+            headers_to_unmask,
+            include_query_in_path,
+        )
+
+    @classmethod
+    def from_dict(cls, dictionary):
+        """
+        Create an instance of RequestLoggingConfiguration from a dictionary.
+
+        Args:
+            dictionary (dict): The input data to convert from.
+
+        """
+        if not dictionary:
+            return cls()
+
+        headers_to_include = dictionary.get("headers_to_include")
+        headers_to_include = [
+            v.strip() for v in headers_to_include.split(",") if v.strip()
+        ] if headers_to_include else None
+
+        headers_to_exclude = dictionary.get("headers_to_exclude")
+        headers_to_exclude = [
+            v.strip() for v in headers_to_exclude.split(",") if v.strip()
+        ] if headers_to_exclude else None
+
+        headers_to_unmask = dictionary.get("headers_to_unmask")
+        headers_to_unmask = [
+            v.strip() for v in headers_to_unmask.split(",") if v.strip()
+        ] if headers_to_unmask else None
+
+        return cls(
+            log_body=dictionary.get("log_body", False),
+            log_headers=dictionary.get("log_headers", False),
+            headers_to_include=headers_to_include,
+            headers_to_exclude=headers_to_exclude,
+            headers_to_unmask=headers_to_unmask,
+            include_query_in_path=dictionary.get("include_query_in_path", False),
+        )
+
+class ResponseLoggingConfiguration(ApiResponseLoggingConfiguration):
+    """
+    Configuration for controlling how API response details are logged.
+    Supports selective logging of headers and body data while allowing
+    masking of sensitive response information.
+    """
+
+    def __init__(self, log_body=False, log_headers=False, headers_to_include=None,
+                 headers_to_exclude=None, headers_to_unmask=None):
+        """
+        Initialize the Response Logging Configuration.
+
+        Args:
+            log_body (bool): Controls the logging of the request body.
+            log_headers (bool): Controls the logging of request headers.
+            headers_to_include (List[str]): Includes only specified headers in the log
+             output.
+            headers_to_exclude (List[str]): Excludes specified headers from the log
+             output.
+            headers_to_unmask (List[str]): Logs specified headers without
+             masking, revealing their actual values.
+
+        """
+        super().__init__(
+            log_body,
+            log_headers,
+            headers_to_include,
+            headers_to_exclude,
+            headers_to_unmask,
+        )
+
+    def clone_with(self, log_body=None, log_headers=None,
+                   headers_to_include=None, headers_to_exclude=None,
+                   headers_to_unmask=None):
+        """
+        Create a copy of this configuration with overridden attributes.
+
+        Args:
+            log_body (bool): Optional override for logging the body.
+            log_headers (bool): Optional override for logging headers.
+            headers_to_include (List[str]): Optional override for included headers.
+            headers_to_exclude (List[str]): Optional override for excluded headers.
+            headers_to_unmask (List[str]): Optional override for unmasked headers.
+
+        Returns:
+            ResponseLoggingConfiguration: A new configuration instance.
+
+        """
+        log_body = log_body or self.log_body
+        log_headers = log_headers or self.log_headers
+        headers_to_include = headers_to_include or self.headers_to_include
+        headers_to_exclude = headers_to_exclude or self.headers_to_exclude
+        headers_to_unmask = headers_to_unmask or self.headers_to_unmask
+
+        return ResponseLoggingConfiguration(
+            log_body,
+            log_headers,
+            headers_to_include,
+            headers_to_exclude,
+            headers_to_unmask,
+        )
+
+    @classmethod
+    def from_dict(cls, dictionary):
+        """
+        Create an instance of ResponseLoggingConfiguration from a dictionary.
+
+        Args:
+            dictionary (dict): The input data to convert from.
+
+        """
+        if not dictionary:
+            return cls()
+
+        headers_to_include = dictionary.get("headers_to_include")
+        headers_to_include = [
+            v.strip() for v in headers_to_include.split(",") if v.strip()
+        ] if headers_to_include else None
+
+        headers_to_exclude = dictionary.get("headers_to_exclude")
+        headers_to_exclude = [
+            v.strip() for v in headers_to_exclude.split(",") if v.strip()
+        ] if headers_to_exclude else None
+
+        headers_to_unmask = dictionary.get("headers_to_unmask")
+        headers_to_unmask = [
+            v.strip() for v in headers_to_unmask.split(",") if v.strip()
+        ] if headers_to_unmask else None
+
+        return cls(
+            log_body=dictionary.get("log_body", False),
+            log_headers=dictionary.get("log_headers", False),
+            headers_to_include=headers_to_include,
+            headers_to_exclude=headers_to_exclude,
+            headers_to_unmask=headers_to_unmask,
+        )
+
+class LoggingConfiguration(ApiLoggingConfiguration):
+    """
+    High-level configuration for API logging behavior. Aggregates both
+    request and response logging settings and applies shared options such
+    as log level and header masking across log events.
+    """
+
+    def __init__(self, logger=None, log_level=None, mask_sensitive_headers=True,
+                 request_logging_config=None, response_logging_config=None):
+        """
+        Initialize the Logging Configuration.
+
+        Args:
+            logger (Logger): The logging implementation to log with.
+            log_level (LogLevel): The log level to apply to the log message.
+            mask_sensitive_headers (bool): Flag to control masking of sensitive headers.
+            request_logging_config (RequestLoggingConfiguration): The API request
+             logging configuration.
+            response_logging_config (ResponseLoggingConfiguration): The API response
+             logging configuration.
+
+        """
+        request_logging_config = request_logging_config or RequestLoggingConfiguration()
+        response_logging_config =\
+            response_logging_config or ResponseLoggingConfiguration()
+        super().__init__(
+            logger,
+            log_level,
+            mask_sensitive_headers,
+            request_logging_config,
+            response_logging_config,
+        )
+
+    def clone_with(self, logger=None, log_level=None, mask_sensitive_headers=None,
+                   request_logging_config=None, response_logging_config=None):
+        """
+        Create a copy of this configuration with overridden attributes.
+
+        Args:
+            logger (Logger): Optional override for the logging implementation.
+            log_level (bool): Optional override for logging level.
+            mask_sensitive_headers (bool): Optional override for masking headers.
+            request_logging_config (RequestLoggingConfiguration): Optional
+             override for request logging configuration.
+            response_logging_config (ResponseLoggingConfiguration): Optional
+             override for response logging configuration.
+
+        Returns:
+            LoggingConfiguration: A new configuration instance.
+
+        """
+        logger = logger or self.logger
+        log_level = log_level or self.log_level
+        mask_sensitive_headers = mask_sensitive_headers or self.mask_sensitive_headers
+        request_logging_config = request_logging_config or self.request_logging_config
+        response_logging_config =\
+            response_logging_config or self.response_logging_config
+
+        return LoggingConfiguration(
+            logger,
+            log_level,
+            mask_sensitive_headers,
+            request_logging_config,
+            response_logging_config,
+        )
+
+    @classmethod
+    def from_dict(cls, dictionary):
+        """
+        Create an instance of LoggingConfiguration from a dictionary.
+        Supports nested request/response logging config dictionaries.
+
+        Args:
+            dictionary (dict): The input data to convert from.
+
+        """
+        if not dictionary:
+            return None
+
+        req_config_dict = dictionary.get("request_logging_config") or {}
+        res_config_dict = dictionary.get("response_logging_config") or {}
+
+        return cls(
+            logger=dictionary.get("logger"),
+            log_level=dictionary.get("log_level"),
+            mask_sensitive_headers=dictionary.get("mask_sensitive_headers", True),
+            request_logging_config=RequestLoggingConfiguration.from_dict(req_config_dict),
+            response_logging_config=ResponseLoggingConfiguration.from_dict(res_config_dict),
+        )
+
+    @classmethod
+    def from_environment(cls):
+        """
+        Create a LoggingConfiguration instance based on environment variables.
+        Environment flags determine whether logging is enabled and how it is
+        configured for requests and responses.
+        """
+        request_logging_env = {
+            "log_body": os.getenv("REQUEST_LOG_BODY", None),
+            "log_headers": os.getenv("REQUEST_LOG_HEADERS", None),
+            "headers_to_include": os.getenv("REQUEST_HEADERS_TO_INCLUDE", None),
+            "headers_to_exclude": os.getenv("REQUEST_HEADERS_TO_EXCLUDE", None),
+            "headers_to_unmask": os.getenv("REQUEST_HEADERS_TO_UNMASK", None),
+            "include_query_in_path": os.getenv("REQUEST_INCLUDE_QUERY_IN_PATH", None),
+        }
+        # Only include if at least one env var is set
+        request_logging_config = (
+                {k: (v.lower() == "true" if v and v.lower() in ["true", "false"] else v)
+                 for k, v in request_logging_env.items() if v is not None}
+                or None
+        )
+
+        # Collect environment variables for response logging
+        response_logging_env = {
+            "log_body": os.getenv("RESPONSE_LOG_BODY", None),
+            "log_headers": os.getenv("RESPONSE_LOG_HEADERS", None),
+            "headers_to_include": os.getenv("RESPONSE_HEADERS_TO_INCLUDE", None),
+            "headers_to_exclude": os.getenv("RESPONSE_HEADERS_TO_EXCLUDE", None),
+            "headers_to_unmask": os.getenv("RESPONSE_HEADERS_TO_UNMASK", None),
+        }
+        response_logging_config = (
+                {k: (v.lower() == "true" if v and v.lower() in ["true", "false"] else v)
+                 for k, v in response_logging_env.items() if v is not None}
+                or None
+        )
+
+        # Determine if any logging-related env variable is set
+        has_logging_env = any([
+            os.getenv("LOG_LEVEL", None),
+            os.getenv("MASK_SENSITIVE_HEADERS", None),
+            request_logging_config,
+            response_logging_config,
+        ])
+
+        log_level = cls._resolve_level(os.getenv("LOG_LEVEL", None))
+
+        # Only instantiate LoggingConfiguration if something is configured
+        return cls.from_dict({
+            "log_level": log_level,
+            "mask_sensitive_headers": os.getenv("MASK_SENSITIVE_HEADERS",
+                                                "true").lower() == "true",
+            "request_logging_config": request_logging_config,
+            "response_logging_config": response_logging_config,
+        }) if has_logging_env else None
+
+    @staticmethod
+    def _resolve_level(value):
+        """
+        Resolve a log level from a string or numeric representation.
+
+        Args:
+            value (str|int): The desired level or its textual name.
+
+        Returns:
+            int: The resolved Python logging level constant.
+
+        """
+        if value is None:
+            return None
+
+        possible_levels = {
+            logging.CRITICAL,
+            logging.ERROR,
+            logging.WARNING,
+            logging.INFO,
+            logging.DEBUG,
+            logging.NOTSET,
+        }
+        # handle numeric values (string or int)
+        if value.isdigit():
+            return int(value) if int(value) in possible_levels else logging.INFO
+        # handle string log level names
+        if isinstance(value, str):
+            level = logging.getLevelName(value.upper())
+            if isinstance(level, int):
+                return level
+
+        return logging.INFO

slackwebapi/logging/sdk_logger.py

@@ -0,0 +1,28 @@
+
+"""
+slackwebapi
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from abc import abstractmethod
+
+from apimatic_core_interfaces.logger.logger import Logger
+
+
+class AbstractLogger(Logger):
+    """An abstract class for custom logger implementation."""
+
+    @abstractmethod
+    def log(self, level, message, params):
+        """
+        Log a message with a specified log level and additional parameters.
+
+        Args:
+            level (int): The log level of the message.
+            message (str): The message to log.
+            params (dict): Additional parameters to include in the log message.
+
+        """
+        ...

slackwebapi/models/__init__.py

@@ -0,0 +1,248 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "admin_conversations_archive_schema",
+    "admin_conversations_convert_to_private_schema",
+    "admin_conversations_create_schema",
+    "admin_conversations_delete_schema",
+    "admin_conversations_get_conversation_prefs_schema",
+    "admin_conversations_get_teams_schema",
+    "admin_conversations_invite_schema",
+    "admin_conversations_rename_schema",
+    "admin_conversations_rename_schema_1",
+    "admin_conversations_search_schema",
+    "admin_conversations_set_conversation_prefs_schema",
+    "admin_conversations_unarchive_schema",
+    "api_method_users_get_presence",
+    "api_permissions_scopes_list_success_schema",
+    "api_test_success_schema",
+    "app_home",
+    "apps_permissions_info_schema",
+    "apps_permissions_request_schema",
+    "apps_permissions_resources_list_success_schema",
+    "apps_uninstall_schema",
+    "attachment",
+    "auth_revoke_schema",
+    "auth_test_success_schema",
+    "block_kit_block",
+    "bot",
+    "bot_profile_object",
+    "bots_info_schema",
+    "can_thread",
+    "channel",
+    "channel_object",
+    "chat_delete_scheduled_message_schema",
+    "chat_delete_success_schema",
+    "chat_get_permalink_success_schema",
+    "chat_me_message_schema",
+    "chat_post_ephemeral_success_schema",
+    "chat_post_message_success_schema",
+    "chat_schedule_message_success_schema",
+    "chat_scheduled_messages_list_schema",
+    "chat_unfurl_success_schema",
+    "chat_update_success_schema",
+    "conversations_archive_success_schema",
+    "conversations_close_success_schema",
+    "conversations_create_success_schema",
+    "conversations_history_success_schema",
+    "conversations_info_success_schema",
+    "conversations_invite_error_schema",
+    "conversations_join_success_schema",
+    "conversations_kick_success_schema",
+    "conversations_leave_success_schema",
+    "conversations_list_success_schema",
+    "conversations_mark_success_schema",
+    "conversations_members_success_schema",
+    "conversations_open_success_schema",
+    "conversations_rename_success_schema",
+    "conversations_replies_success_schema",
+    "conversations_set_purpose_success_schema",
+    "conversations_set_topic_success_schema",
+    "conversations_unarchive_success_schema",
+    "current",
+    "default_success_template",
+    "dialog_open_schema",
+    "dnd_end_dnd_schema",
+    "dnd_end_snooze_schema",
+    "dnd_info_schema",
+    "dnd_set_snooze_schema",
+    "error",
+    "error_1",
+    "error_10",
+    "error_11",
+    "error_12",
+    "error_13",
+    "error_14",
+    "error_16",
+    "error_17",
+    "error_18",
+    "error_19",
+    "error_2",
+    "error_20",
+    "error_21",
+    "error_22",
+    "error_23",
+    "error_24",
+    "error_25",
+    "error_26",
+    "error_27",
+    "error_28",
+    "error_29",
+    "error_3",
+    "error_30",
+    "error_31",
+    "error_32",
+    "error_33",
+    "error_34",
+    "error_35",
+    "error_37",
+    "error_38",
+    "error_39",
+    "error_4",
+    "error_40",
+    "error_41",
+    "error_42",
+    "error_43",
+    "error_44",
+    "error_45",
+    "error_46",
+    "error_48",
+    "error_49",
+    "error_5",
+    "error_50",
+    "error_51",
+    "error_52",
+    "error_53",
+    "error_54",
+    "error_55",
+    "error_56",
+    "error_57",
+    "error_58",
+    "error_59",
+    "error_6",
+    "error_60",
+    "error_61",
+    "error_62",
+    "error_63",
+    "error_64",
+    "error_65",
+    "error_66",
+    "error_67",
+    "error_68",
+    "error_69",
+    "error_7",
+    "error_70",
+    "error_71",
+    "error_74",
+    "error_75",
+    "error_77",
+    "error_78",
+    "error_8",
+    "error_81",
+    "error_82",
+    "error_84",
+    "error_86",
+    "error_89",
+    "error_9",
+    "error_92",
+    "error_93",
+    "error_94",
+    "error_95",
+    "error_96",
+    "error_97",
+    "error_98",
+    "error_99",
+    "errors_is_returned_when_an_error_associates_an_user",
+    "external_org_migrations",
+    "file_comment_object",
+    "file_object",
+    "files_comments_delete_schema",
+    "files_delete_schema",
+    "files_info_schema",
+    "files_list_schema",
+    "files_revoke_public_url_schema",
+    "files_shared_public_url_schema",
+    "files_upload_schema",
+    "group",
+    "icons",
+    "icons_1",
+    "im",
+    "info",
+    "log",
+    "login",
+    "message",
+    "message_object",
+    "message_object_1",
+    "migration_exchange_success_schema",
+    "mpim",
+    "mself",
+    "mtype",
+    "oauth_provider_error",
+    "oauth_scope",
+    "oauth_token",
+    "objs_enterprise_user",
+    "objs_icon",
+    "objs_primary_owner",
+    "objs_reminder",
+    "objs_team_profile_field",
+    "objs_team_profile_field_option",
+    "objs_user_profile_short",
+    "paging_object",
+    "pins_add_schema",
+    "pins_remove_schema",
+    "plan",
+    "prefs",
+    "prefs_1",
+    "profile",
+    "profile_1",
+    "purpose",
+    "reaction_object",
+    "reactions_add_schema",
+    "reactions_list_schema",
+    "reactions_remove_schema",
+    "reminders_add_schema",
+    "reminders_complete_schema",
+    "reminders_delete_schema",
+    "reminders_info_schema",
+    "reminders_list_schema",
+    "resource",
+    "resources_in_info_from_apps_permissions_info",
+    "response_metadata",
+    "response_metadata_3",
+    "rtm_connect_schema",
+    "scheduled_message",
+    "scopes",
+    "shares",
+    "sso_provider",
+    "stars_add_schema",
+    "stars_list_schema",
+    "stars_remove_schema",
+    "subteam_usergroup_object",
+    "team",
+    "team_1",
+    "team_access_logs_schema",
+    "team_info_schema",
+    "team_integration_logs_schema",
+    "team_object",
+    "team_profile_get_success_schema",
+    "topic",
+    "user_profile_object",
+    "usergroups_create_schema",
+    "usergroups_disable_schema",
+    "usergroups_enable_schema",
+    "usergroups_list_schema",
+    "usergroups_update_schema",
+    "usergroups_users_list_schema",
+    "usergroups_users_update_schema",
+    "users_conversations_success_schema",
+    "users_delete_photo_schema",
+    "users_info_success_schema",
+    "users_list_schema",
+    "users_lookup_by_email_success_schema",
+    "users_profile_get_schema",
+    "users_profile_set_schema",
+    "users_set_active_schema",
+    "users_set_photo_schema",
+    "users_set_presence_schema",
+    "who_can_post",
+]