Fix linter code style warnings (#11)

Author: paoptu023

.pylintrc

@@ -168,6 +168,7 @@ function-naming-style=snake_case
 good-names=i,
            j,
            k,
+           e,
            ex,
            Run,
            _

Makefile

@@ -9,11 +9,14 @@ test:
 flake:
 	# Make sure code conforms to PEP8 standards
 	pipenv run flake8 serverlessrepo
-	pipenv run flake8 tests
+	# Ignore missing docstring errors for tests
+	pipenv run flake8 tests --ignore=D100,D101,D102,D103,D104
 
 lint:
 	# Linter performs static analysis to catch latent bugs
 	pipenv run pylint --rcfile .pylintrc serverlessrepo
+	# Ignore missing docstring errors for tests
+	pipenv run pylint --rcfile .pylintrc tests --disable=C0111
 
 # Command to run everytime you make changes to verify everything works
 build: flake lint test

README.md

@@ -6,7 +6,7 @@ A Python library with convenience helpers for working with the [AWS Serverless A
 
 Simply use pip to install the library:
 
-```
+```text
 pip install serverlessrepo
 ```
 
@@ -24,7 +24,7 @@ import serverlessrepo
 
 Given an [AWS Serverless Application Model (SAM)](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md) template, it publishes a new application using the specified metadata in AWS Serverless Application Repository. If the application already exists, it publishes a new application version.
 
-#### publish_application_metadata(template, application_id)
+#### update_application_metadata(template, application_id)
 
 Parses the application metadata from the SAM template and updates the application.
 
@@ -43,12 +43,12 @@ with open('template.yaml', 'r') as f:
 Or updates the application's metadata using template.yaml:
 
 ```python
-from serverlessrepo import publish_application_metadata
+from serverlessrepo import update_application_metadata
 
 with open('template.yaml', 'r') as f:
     template = f.read()
     application_id = 'arn:aws:serverlessrepo:us-east-1:123456789012:applications/test-app'
-    publish_application_metadata(template, application_id)
+    update_application_metadata(template, application_id)
 ```
 
 ### Manage Application Permissions

serverlessrepo/__init__.py

@@ -1,8 +1,10 @@
-"""
-Common library for AWS Serverless Application Repository
-"""
+"""Common library for AWS Serverless Application Repository."""
+
+from .publish import (  # noqa: F401
+    publish_application,
+    update_application_metadata
+)
 
-from .publish import publish_application  # noqa: F401
 from .permission_helper import (  # noqa: F401
     make_application_public,
     make_application_private,

serverlessrepo/__version__.py

@@ -1,6 +1,4 @@
-"""
-Serverlessrepo version and package meta-data.
-"""
+"""Serverlessrepo version and package meta-data."""
 
 __title__ = 'serverlessrepo'
 __version__ = '0.1.0'
@@ -11,4 +9,4 @@
 )
 __url__ = 'https://github.com/awslabs/aws-serverlessrepo-python'
 __author__ = 'Amazon Web Services'
-__author_email__ = '<TBD>'
+__author_email__ = '[email protected]'

serverlessrepo/application_metadata.py

@@ -1,10 +1,10 @@
+"""Module containing class to store SAR application metadata."""
+
 from .exceptions import InvalidApplicationMetadataError
 
 
 class ApplicationMetadata(object):
-    """
-    Class representing SAR metadata
-    """
+    """Class representing SAR metadata."""
 
     # SAM template SAR metadata properties
     _NAME = 'Name'
@@ -20,7 +20,7 @@ class ApplicationMetadata(object):
 
     def __init__(self, app_metadata):
         """
-        Initializes the object given SAR metadata properties
+        Initialize the object given SAR metadata properties.
 
         :param app_metadata: Dictionary containing SAR metadata properties
         :type app_metadata: dict
@@ -37,11 +37,12 @@ def __init__(self, app_metadata):
         self.source_code_url = app_metadata.get(self._SOURCE_CODE_URL)
 
     def __eq__(self, other):
+        """Return whether two ApplicationMetadata objects are equal."""
         return isinstance(other, type(self)) and self.__dict__ == other.__dict__
 
     def validate(self, required_props):
         """
-        Checks if the required application metadata properties have been populated
+        Check if the required application metadata properties have been populated.
 
         :param required_props: List of required properties
         :type required_props: list

serverlessrepo/application_policy.py

@@ -1,12 +1,12 @@
+"""Module containing class to store SAR application permissions."""
+
 import re
 
 from .exceptions import InvalidApplicationPolicyError
 
 
 class ApplicationPolicy(object):
-    """
-    Class representing SAR application policy
-    """
+    """Class representing SAR application policy."""
 
     # Supported actions for setting SAR application permissions
     GET_APPLICATION = 'GetApplication'
@@ -31,7 +31,7 @@ class ApplicationPolicy(object):
 
     def __init__(self, principals, actions):
         """
-        Initializes the object given the principals and actions
+        Initialize the object given the principals and actions.
 
         :param principals: List of AWS account IDs, or *
         :type principals: list of str
@@ -43,7 +43,7 @@ def __init__(self, principals, actions):
 
     def validate(self):
         """
-        Checks if the formats of principals and actions are valid
+        Check if the formats of principals and actions are valid.
 
         :return: True, if the policy is valid
         :raises: InvalidApplicationPolicyError
@@ -59,15 +59,15 @@ def validate(self):
                 error_message='principal should be 12-digit AWS account ID or "*"')
 
         unsupported_actions = sorted(set(self.actions) - set(self.SUPPORTED_ACTIONS))
-        if len(unsupported_actions):
+        if unsupported_actions:
             raise InvalidApplicationPolicyError(
                 error_message='{} not supported'.format(', '.join(unsupported_actions)))
 
         return True
 
     def to_statement(self):
         """
-        Converts to a policy statement dictionary
+        Convert to a policy statement dictionary.
 
         :return: Dictionary containing Actions and Principals
         :rtype: dict

serverlessrepo/exceptions.py

@@ -1,32 +1,29 @@
-"""
-Collection of public exceptions raised by this library
-"""
+"""Collection of public exceptions raised by this library."""
 
 
 class ServerlessRepoError(Exception):
+    """Base exception raised by serverlessrepo library."""
 
     MESSAGE = ''
 
     def __init__(self, **kwargs):
+        """Init the exception object."""
         Exception.__init__(self, self.MESSAGE.format(**kwargs))
 
 
 class InvalidApplicationMetadataError(ServerlessRepoError):
-    """
-    Raised when invalid application metadata is provided
-    """
+    """Raised when invalid application metadata is provided."""
+
     MESSAGE = "Required application metadata properties not provided: '{properties}'"
 
 
 class ApplicationMetadataNotFoundError(ServerlessRepoError):
-    """
-    Raised when application metadata is not found
-    """
+    """Raised when application metadata is not found."""
+
     MESSAGE = "Application metadata not found in the SAM template: '{error_message}'"
 
 
 class InvalidApplicationPolicyError(ServerlessRepoError):
-    """
-    Raised when invalid application policy is provided
-    """
+    """Raised when invalid application policy is provided."""
+
     MESSAGE = "Invalid application policy: '{error_message}'"

serverlessrepo/parser.py

@@ -1,13 +1,11 @@
-"""
-Helper to parse JSON/YAML SAM template and dump YAML files
-"""
+"""Helper to parse JSON/YAML SAM template and dump YAML files."""
 
 import re
 import json
+from collections import OrderedDict
 import six
 import yaml
 from yaml.resolver import ScalarNode, SequenceNode
-from collections import OrderedDict
 
 from .application_metadata import ApplicationMetadata
 from .exceptions import ApplicationMetadataNotFoundError
@@ -20,9 +18,9 @@
 def intrinsics_multi_constructor(loader, tag_prefix, node):
     """
     YAML constructor to parse CloudFormation intrinsics.
-    This will return a dictionary with key being the instrinsic name
-    """
 
+    :return: a dictionary with key being the instrinsic name
+    """
     # Get the actual tag name excluding the first exclamation
     tag = node.tag[1:]
 
@@ -60,7 +58,8 @@ def _dict_representer(dumper, data):
 
 def yaml_dump(dict_to_dump):
     """
-    This function dumps the dictionary as a YAML document
+    Dump the dictionary as a YAML document.
+
     :param dict_to_dump: Data to be serialized as YAML
     :type dict_to_dump: dict
     :return: YAML document
@@ -76,7 +75,7 @@ def _dict_constructor(loader, node):
 
 def parse_template(template_str):
     """
-    This function parses the SAM template
+    Parse the SAM template.
 
     :param template_str: A packaged YAML or json CloudFormation template
     :type template_str: str
@@ -96,7 +95,7 @@ def parse_template(template_str):
 
 def get_app_metadata(template_dict):
     """
-    This function gets the application metadata from a SAM template
+    Get the application metadata from a SAM template.
 
     :param template_dict: SAM template as a dictionary
     :type template_dict: dict
@@ -107,11 +106,19 @@ def get_app_metadata(template_dict):
     if METADATA in template_dict and SERVERLESS_REPO_APPLICATION in template_dict[METADATA]:
         app_metadata_dict = template_dict[METADATA][SERVERLESS_REPO_APPLICATION]
         return ApplicationMetadata(app_metadata_dict)
-    else:
-        raise ApplicationMetadataNotFoundError(
-            error_message='missing {} section in template Metadata'.format(SERVERLESS_REPO_APPLICATION))
+
+    raise ApplicationMetadataNotFoundError(
+        error_message='missing {} section in template Metadata'.format(SERVERLESS_REPO_APPLICATION))
 
 
 def parse_application_id(text):
+    """
+    Extract the application id from input text.
+
+    :param text: text to parse
+    :type text: str
+    :return: application id if found in the input
+    :rtype: str
+    """
     result = re.search(APPLICATION_ID_PATTERN, text)
     return result.group(0) if result else None

serverlessrepo/permission_helper.py

@@ -1,11 +1,14 @@
+"""Module containing methods to manage application permissions."""
+
 import boto3
 
 from .application_policy import ApplicationPolicy
 
 
 def make_application_public(application_id):
     """
-    This function sets the application to be public
+    Set the application to be public.
+
     :raises ValueError
     """
     if not application_id:
@@ -21,7 +24,8 @@ def make_application_public(application_id):
 
 def make_application_private(application_id):
     """
-    This function sets the application to be private
+    Set the application to be private.
+
     :raises ValueError
     """
     if not application_id:
@@ -35,7 +39,8 @@ def make_application_private(application_id):
 
 def share_application_with_accounts(application_id, account_ids):
     """
-    This function shares the application privately with given AWS account IDs
+    Share the application privately with given AWS account IDs.
+
     :param account_ids: List of AWS account IDs, or *
     :type account_ids: list of str
     :raises ValueError

serverlessrepo/publish.py

@@ -1,3 +1,5 @@
+"""Module containing functions to publish or update application."""
+
 import boto3
 from botocore.exceptions import ClientError
 
@@ -8,7 +10,7 @@
 
 def publish_application(template):
     """
-    This function publishes the application
+    Create a new application or new application version in SAR.
 
     :param template: A packaged YAML or JSON SAM template
     :type template: str
@@ -46,9 +48,9 @@ def publish_application(template):
     }
 
 
-def publish_application_metadata(template, application_id):
+def update_application_metadata(template, application_id):
     """
-    This function updates the application metadata
+    Update the application metadata.
 
     :param template: A packaged YAML or JSON SAM template
     :type template: str
@@ -67,7 +69,7 @@ def publish_application_metadata(template, application_id):
 
 def _create_application_request(app_metadata, template):
     """
-    This function constructs the request body to create application
+    Construct the request body to create application.
 
     :param app_metadata: Object containing app metadata
     :type app_metadata: ApplicationMetadata
@@ -96,7 +98,7 @@ def _create_application_request(app_metadata, template):
 
 def _update_application_request(app_metadata, application_id):
     """
-    This function constructs the request body to update application
+    Construct the request body to update application.
 
     :param app_metadata: Object containing app metadata
     :type app_metadata: ApplicationMetadata
@@ -118,7 +120,7 @@ def _update_application_request(app_metadata, application_id):
 
 def _create_application_version_request(app_metadata, application_id, template):
     """
-    This function constructs the request body to create application version
+    Construct the request body to create application version.
 
     :param app_metadata: Object containing app metadata
     :type app_metadata: ApplicationMetadata
@@ -141,7 +143,7 @@ def _create_application_version_request(app_metadata, application_id, template):
 
 def _is_conflict_exception(e):
     """
-    This function checks whether the boto3 ClientError is ConflictException
+    Check whether the boto3 ClientError is ConflictException.
 
     :param e: boto3 exception
     :type e: ClientError