C0116 missing-function-docstring--pylint--enabled

Author: Bryan Sieber

infra/gunicorn_conf.py

@@ -73,5 +73,5 @@
 }
 
 
-def child_exit(server, worker):
+def child_exit(server, worker):  # pylint: disable=missing-function-docstring
     multiprocess.mark_process_dead(worker.pid)

pyproject.toml

@@ -45,7 +45,6 @@ testpaths = [
 [tool.pylint]
     [tool.pylint.'MESSAGES CONTROL']
     disable = [
-        "C0116", #missing-function-docstring
         "C0301", #line-too-long
         "R0903", #too-few-public-methods
         "W0613", #unused-argument

src/app/api.py

@@ -40,6 +40,12 @@ def root(request: Request):
 
 @app.middleware("http")
 async def request_summary(request: Request, call_next):
+    """
+    Middleware to log request info
+    :param request:
+    :param call_next:
+    :return: response
+    """
     summary_logger = logging.getLogger("request.summary")
     previous_time = time.time()
 
@@ -66,6 +72,10 @@ async def request_summary(request: Request, call_next):
 
 @app.on_event("startup")
 def startup_event():
+    """
+    On app startup perform these setup operations
+    :return:
+    """
     configure_logging()
 
 

src/app/environment.py

@@ -33,6 +33,9 @@ class Settings(BaseSettings):
 
 @lru_cache()
 def get_settings() -> Settings:
+    """
+    Return the Settings object; use cache
+    """
     return Settings()
 
 

src/app/log.py

@@ -11,6 +11,9 @@
 
 
 def configure_logging():
+    """
+    Configure logging; mozlog format for Dockerflow
+    """
     logging_config = {
         "version": 1,
         "formatters": {

src/app/monitor.py

@@ -28,6 +28,9 @@ def get_heartbeat(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
+    """
+    Dockerflow API for heartbeat: GET
+    """
     return heartbeat(request, settings)
 
 
@@ -36,6 +39,9 @@ def head_heartbeat(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
+    """
+    Dockerflow API for heartbeat: HEAD
+    """
     return heartbeat(request, settings)
 
 
@@ -46,11 +52,17 @@ def lbheartbeat(request: Request):
 
 @api_router.get("/__lbheartbeat__")
 def get_lbheartbeat(request: Request):
+    """
+    Dockerflow API for lbheartbeat: GET
+    """
     return lbheartbeat(request)
 
 
 @api_router.head("/__lbheartbeat__")
 def head_lbheartbeat(request: Request):
+    """
+    Dockerflow API for lbheartbeat: HEAD
+    """
     return lbheartbeat(request)
 
 

src/jbi/configuration.py

@@ -31,6 +31,9 @@ class ProcessError(Exception):
 def get_yaml_configurations(
     jbi_config_file: str = f"config/config.{settings.env}.yaml",
 ) -> Dict[str, Dict]:
+    """
+    Convert and validate YAML configuration to python dict
+    """
 
     with open(jbi_config_file, encoding="utf-8") as file:
         try:
@@ -46,6 +49,9 @@ def get_yaml_configurations(
 
 
 def process_actions(action_configuration) -> Dict[str, Dict]:
+    """
+    Validate `actions` section of the YAML config
+    """
     requested_actions = {}
     for yaml_action_key, inner_action_dict in action_configuration.items():
         inner_action_dict.setdefault("action", "src.jbi.whiteboard_actions.default")
@@ -60,7 +66,7 @@ def process_actions(action_configuration) -> Dict[str, Dict]:
 
 
 def validate_action_yaml_jbi_naming(yaml_action_key, action_dict):
-    # Validate yaml_action_key == parameters.whiteboard_tag
+    """Validate yaml_action_key == parameters.whiteboard_tag"""
     wb_tag = action_dict["parameters"].get("whiteboard_tag")
     if yaml_action_key != wb_tag:
         raise ConfigError(
@@ -70,7 +76,7 @@ def validate_action_yaml_jbi_naming(yaml_action_key, action_dict):
 
 
 def validate_action_yaml_module(action_dict: Dict[str, Any]):
-    # Validate action: exists, has init function, and has expected params
+    """Validate action: exists, has init function, and has expected params"""
     try:
         action: str = action_dict.get("action")  # type: ignore
         action_parameters: Optional[Dict[str, Any]] = action_dict.get("parameters")

src/jbi/router.py

@@ -19,24 +19,29 @@
 
 
 def execute_request(request, settings):
-    # Is request valid?
-    # Is whiteboard known?
-    # Execute desired action -- based on whiteboard config
-    pass
+    """
+    Is request valid?
+    Is whiteboard known?
+    Execute desired action -- based on whiteboard config
+    """
 
 
 @api_router.post("/bugzilla_webhook")
 def bugzilla_webhook(
     request: Request,
     settings: environment.Settings = Depends(environment.get_settings),
 ):
+    """
+    API endpoint that Bugzilla Webhook Events request
+    """
     return execute_request(request, settings)
 
 
 @api_router.get("/whiteboard_tags/")
 def get_whiteboard_tag(
     whiteboard_tag: Optional[str] = None,
 ):
+    """API for viewing whiteboard_tags"""
     data = configuration.get_yaml_configurations()
     if whiteboard_tag:
         wb_val = data.get(whiteboard_tag)
@@ -47,6 +52,7 @@ def get_whiteboard_tag(
 
 @api_router.get("/actions/")
 def get_actions_by_type(action_type: Optional[str] = None):
+    """API for viewing actions"""
     configured_actions = configuration.get_yaml_configurations()
     if action_type:
         data = [
@@ -61,6 +67,7 @@ def get_actions_by_type(action_type: Optional[str] = None):
 
 @api_router.get("/powered_by_jbi", response_class=HTMLResponse)
 def powered_by_jbi(request: Request, enabled: Optional[bool] = None):
+    """API for `Powered By` endpoint"""
     data = configuration.get_yaml_configurations()
     context = {
         "request": request,

src/jbi/services.py

@@ -13,6 +13,7 @@
 
 
 def get_jira():
+    """Get atlassian Jira Service"""
     return Jira(
         url=settings.jira_base_url,
         username=settings.jira_username,
@@ -21,18 +22,21 @@ def get_jira():
 
 
 def get_bugzilla():
+    """Get bugzilla service"""
     return rh_bugzilla.Bugzilla(
         settings.bugzilla_base_url, api_key=settings.bugzilla_api_key
     )
 
 
 def bugzilla_check_health():
+    """Check health for Bugzilla Service"""
     bugzilla = get_bugzilla()
     health = {"up": bugzilla.logged_in}
     return health
 
 
 def jira_check_health():
+    """Check health for Jira Service"""
     jira = get_jira()
     server_info = jira.get_server_info(True)
     services_logger.info(server_info)
@@ -41,6 +45,7 @@ def jira_check_health():
 
 
 def jbi_service_health_map():
+    """Returns dictionary of health check's for Bugzilla and Jira Services"""
     return {
         "bugzilla": bugzilla_check_health(),
         "jira": jira_check_health(),

src/jbi/whiteboard_actions/default.py

@@ -8,6 +8,13 @@
 
 
 def init(whiteboard_tag, jira_project_key, **kwargs):
+    """
+    Function that takes required and optional params and returns a callable object
+    :param whiteboard_tag: Required param
+    :param jira_project_key: Required param
+    :param kwargs: Optional params
+    :return: DefaultExecutor
+    """
     return DefaultExecutor(
         whiteboard_tag=whiteboard_tag, jira_project_key=jira_project_key, **kwargs
     )
@@ -19,12 +26,15 @@ class DefaultExecutor:
     """
 
     def __init__(self, **kwargs):
+        """Initialize DefaultExecutor Object"""
         self.parameters = kwargs
         self.whiteboard_tag = kwargs.get("whiteboard_tag")
         self.jira_project_key = kwargs.get("jira_project_key")
 
     def __call__(self, payload):
-        # Called from BZ webhook
-        # Call Jira SDK with project key etc.
+        """
+        Called from BZ webhook
+        Call Jira SDK with project key etc.
+        """
         print(payload)
         print(self.parameters)