global: fixes docstrings

Signed-off-by: Ioannis Tsanaktsidis <[email protected]>

Author: ioannistsanaktsidis

cap/factory.py

@@ -11,9 +11,7 @@
 from __future__ import absolute_import, print_function
 
 import os
-import sys
 
-import pkg_resources
 from invenio_base.app import create_app_factory
 from invenio_base.wsgi import wsgi_proxyfix
 from invenio_cache import BytecodeCache
@@ -23,22 +21,14 @@
 from invenio_app.factory import (
     app_class,
     invenio_config_loader,
-    instance_path,
-    static_folder)
+    instance_path
+)
 
 
 def config_loader(app, **kwargs_config):
-    """Configuration loader.
-
-    Adds support for loading templates from the Flask application's instance
-    folder (``<instance_folder>/templates``).
-    """
-    # This is the only place customize the Flask application right after
-    # it has been created, but before all extensions etc are loaded.
+    """Add loading templates."""
     local_templates_path = os.path.join(app.instance_path, 'templates')
     if os.path.exists(local_templates_path):
-        # Let's customize the template loader to look into packages
-        # and application templates folders.
         app.jinja_loader = ChoiceLoader([
             FileSystemLoader(local_templates_path),
             app.jinja_loader,
@@ -64,4 +54,3 @@ def config_loader(app, **kwargs_config):
     instance_path=instance_path,
     app_class=app_class(),
 )
-"""Flask application factory for Invenio REST API."""

cap/modules/access/permissions.py

@@ -29,7 +29,7 @@
 
 
 def admin_permission_factory(view):
-    """Default factory for creating a permission for an admin.
+    """Create a permission for an admin.
 
     It tries to load a :class:`invenio_access.permissions.DynamicPermission`
     instance if `invenio_access` is installed.

cap/modules/deposit/api.py

@@ -383,7 +383,7 @@ def _remove_user_permissions(self,
                                  user,
                                  permissions,
                                  session):
-        """Removes permissions for user for this deposit."""
+        """Remove permissions for user for this deposit."""
         for permission in permissions:
             session.delete(
                 ActionUsers.query.filter(
@@ -440,7 +440,7 @@ def _init_owner_permissions(self, owner=current_user):
             self['_deposit']['owners'] = [owner.id]
 
     def _construct_fileinfo(self, url, type):
-        """Constructs repo name  or file name."""
+        """Construct repo name  or file name."""
         url = url.rstrip('/')
         branch = None
         if type == 'repo':
@@ -602,7 +602,7 @@ def download_repo(pid, url, filename):
 
 
 def task_commit(record, response, filename, total):
-    """Commits file to the record."""
+    """Commit file to the record."""
     record.files[filename].file.set_contents(
         response,
         default_location=record.files.bucket.location.uri,
@@ -616,7 +616,7 @@ def ensure_content_length(
         session=None,
         max_size=FILES_URL_MAX_SIZE or 2**20,
         *args, **kwargs):
-    """Adds Content-Length when no present."""
+    """Add Content-Length when no present."""
     kwargs['stream'] = True
     session = session or requests.Session()
     r = session.request(method, url, *args, **kwargs)

cap/modules/deposit/utils.py

@@ -29,7 +29,7 @@
 
 
 def clean_empty_values(data):
-    """Removes empty values from model."""
+    """Remove empty values from model."""
     if not isinstance(data, (dict, list)):
         return data
     if isinstance(data, list):

cap/modules/experiments/views/atlas.py

@@ -45,7 +45,7 @@
 @atlas_bp.route('/yadage/workflow_submit', methods=['POST'])
 @atlas_permission.require(403)
 def yadage_workflow_submit():
-    """Submits a yadage workflow."""
+    """Submit a yadage workflow."""
     resp = request.get_json()
 
     at = resp.get('at', None)

cap/modules/experiments/views/cms.py

@@ -45,7 +45,7 @@
 @cms_bp.route('/cadi/<cadi_id>', methods=['GET'])
 @cms_permission.require(403)
 def get_analysis_from_cadi(cadi_id):
-    """Retrieves specific CADI analysis."""
+    """Retrieve specific CADI analysis."""
     cadi_id = unquote(cadi_id).upper()
     url = current_app.config['CADI_GET_RECORD_URL'] + cadi_id
 
@@ -67,7 +67,7 @@ def get_analysis_from_cadi(cadi_id):
 @cms_bp.route('/datasets', methods=['GET'])
 @cms_permission.require(403)
 def get_datasets_names():
-    """Retrieves specific dataset names."""
+    """Retrieve specific dataset names."""
     term = unquote(request.args.get('query', ''))
     query = {
         "suggest": {

cap/modules/experiments/views/lhcb.py

@@ -47,7 +47,7 @@
 @lhcb_bp.route('/analysis', methods=['GET'])
 @lhcb_permission.require(403)
 def lhcb_get_analysis():
-    """Retrieves lhcb analysis."""
+    """Retrieve lhcb analysis."""
     query = unquote(request.args.get('query', ''))
     location = current_app.config.get('LHCB_DB_FILES_LOCATION', '')
 
@@ -63,7 +63,7 @@ def lhcb_get_analysis():
 @lhcb_bp.route('/analysis/details', methods=['GET'])
 @lhcb_permission.require(403)
 def lhcb_get_analysis_data():
-    """Retrieves lhcb analysis data."""
+    """Retrieve lhcb analysis data."""
     title = unquote(request.args.get('title', ''))
     location = current_app.config.get('LHCB_DB_FILES_LOCATION', '')
 
@@ -78,7 +78,7 @@ def lhcb_get_analysis_data():
 @lhcb_bp.route('/analysis/collisiondata/', methods=['GET'])
 @lhcb_permission.require(403)
 def lhcb_get_collision_data():
-    """Retrieves lhcb analysis collision data."""
+    """Retrieve lhcb analysis collision data."""
     stripping_line = request.args.get('stripping_line', '')
     params = parse_stripping_line(unquote(stripping_line))
     url = current_app.config.get('LHCB_GETCOLLISIONDATA_URL', '')
@@ -110,7 +110,7 @@ def lhcb_get_collision_data():
 @lhcb_bp.route('/analysis/platforms', methods=['GET'])
 @lhcb_permission.require(403)
 def lhcb_get_platforms():
-    """Retrieves lhcb analysis platforms."""
+    """Retrieve lhcb analysis platforms."""
     app = request.args.get('application', '').replace(' ', '-')
     url = current_app.config.get('LHCB_GETPLATFORM_URL', '') + app
 
@@ -127,7 +127,7 @@ def lhcb_get_platforms():
 
 
 def get_soft_info(url):
-    """Retrieves lhcb analysis soft info."""
+    """Retrieve lhcb analysis soft info."""
     soft = version = ''
 
     response = requests.get(url).json()
@@ -139,7 +139,7 @@ def get_soft_info(url):
 
 
 def parse_stripping_line(stripping_line):
-    """Parses stripping line."""
+    """Parse stripping line."""
     regex = r'Collision(?P<year>\d{2})' + \
         r'.*(?P<reco>Reco[^/]*)' + \
         r'.*(?P<stripping>Stripping[^/]*)'

cap/modules/fixtures/utils.py

@@ -58,7 +58,7 @@ def construct_draft_obj(schema, data):
 
 
 def get_entry_uuid_by_unique_field(index, dict_unique_field_value):
-    """Returns record by uuid."""
+    """Return record by uuid."""
     rs = RecordsSearch(index=index)
     res = rs.query(Q('match',
                      **dict_unique_field_value)).execute().hits.hits
@@ -70,7 +70,7 @@ def get_entry_uuid_by_unique_field(index, dict_unique_field_value):
 
 
 def add_read_permission_for_egroup(deposit, egroup):
-    """Adds read permission for egroup."""
+    """Add read permission for egroup."""
     role = Role.query.filter_by(name=egroup).one()
     deposit._add_egroup_permissions(role,
                                     ['deposit-read'],
@@ -81,7 +81,7 @@ def add_read_permission_for_egroup(deposit, egroup):
 
 def add_drafts_from_file(file_path, schema,
                          egroup=None, usermail=None, limit=None):
-    """Adds drafts from a specified file.
+    """Add drafts from a specified file.
 
     Drafts with specified pid will be registered under those.
     For drafts without pid, new pids will be minted.

cap/modules/oauth2server/views/settings.py

@@ -50,7 +50,7 @@
 # Decorator
 #
 def client_getter():
-    """Decorator to retrieve Client object and check user permission."""
+    """Retrieve Client object and check user permission."""
     def wrapper(f):
         @wraps(f)
         def decorated(*args, **kwargs):
@@ -71,7 +71,7 @@ def decorated(*args, **kwargs):
 
 
 def token_getter(is_personal=True, is_internal=False):
-    """Decorator to retrieve Token object and check user permission.
+    """Retrieve Token object and check user permission.
 
     :param is_personal: Search for a personal token. (Default: ``True``)
     :param is_internal: Search for a internal token. (Default: ``False``)

cap/modules/oauthclient/rest_handlers.py

@@ -230,7 +230,7 @@ def token_delete(remote, token=''):
 # Error handling decorators
 #
 def oauth_error_handler(f):
-    """Decorator to handle exceptions."""
+    """Handle exceptions."""
     @wraps(f)
     def inner(*args, **kwargs):
         # OAuthErrors should not happen, so they are not caught here. Hence