!34 Modify notes as required

Merge pull request !34 from jiangpengjuj/master

packageship/packageship/application/app_global.py

 #!/usr/bin/python3
-'''
-    Interception before request
-'''
+"""
+Description: Interception before request
+"""
 from flask import request
 from packageship.application import OPERATION
 from packageship.application.apps.package.url import urls
@@ -11,9 +11,12 @@ __all__ = ['identity_verification']
 
 
 def identity_verification():
-    '''
-        Requested authentication
-    '''
+    """
+    Description: Requested authentication
+    Args:
+    Returns:
+    Raises:
+    """
     if request.url_rule:
         url_rule = request.url_rule.rule
         for view, url, authentication in urls:

packageship/packageship/application/apps/package/function/constants.py

-'''
-    Response contain and code ID
-'''
+#!/usr/bin/python3
+"""
+Description: Response contain and code ID
+class: ListNode, ResponseCode
+"""
 
 
-class ListNode:
+class ListNode():
     """
-    the structure of dict:
+    Description: Dethe structure of dict:
     {package_name: [source_name,
                 dbname,
                 [[parent_node_1, depend_type],[parent_node_2, depend_type],...]],
                 check_tag]
     }
+    changeLog:
     """
 
     SOURCE_NAME = 0
@@ -26,8 +29,8 @@ class ListNode:
 
 class ResponseCode():
     """
-        Description: response code to web
-        changeLog:
+    Description: response code to web
+    changeLog:
     """
     # Four digits are common status codes
     SUCCESS = "2001"
@@ -66,7 +69,7 @@ class ResponseCode():
     @classmethod
     def response_json(cls, code, data=None):
         """
-        classmethod
+        Description: classmethod
         """
         return {
             "code": code,

packageship/packageship/application/apps/package/function/packages.py

+#!/usr/bin/python3
 """
-docstring:Get package information and modify package information
+Description: Get package information and modify package information
+functions: get_packages, buildep_packages, sub_packages, get_single_package,
+ update_single_package, update_maintaniner_info
 """
 from flask import current_app
 
@@ -13,11 +16,16 @@ from packageship.libs.exception import Error
 
 
 def get_packages(dbname):
-    '''
+    """
     Description: Get all packages info
-    :param dbname: Database name
-    :return: package info
-    '''
+    Args:
+        dbname: Database name
+    Returns:
+        Package information is returned as a list
+    Raises:
+        AttributeError: Object does not have this property
+        Error: Abnormal error
+    """
     with DBHelper(db_name=dbname) as db_name:
         src_pack_queryset = db_name.session.query(src_pack).all()
         resp_list = []
@@ -39,9 +47,13 @@ def get_packages(dbname):
 def buildep_packages(dbname, src_pack_id):
     """
     Description: Query package layer 1 compilation dependency
-    :param dbname:  databases name
-    :param src_pack_id: srcpackage id
-    :return:  buildDep   Compile dependencies of source packages
+    Args:
+        dbname:  databases name
+        src_pack_id: The ID of the source package
+    Returns:
+        buildDep Compile dependencies of source packages
+    Raises:
+        AttributeError: Object does not have this property
     """
     with DBHelper(db_name=dbname) as db_name:
         b_pack_requires_set = db_name.session.query(
@@ -61,10 +73,14 @@ def buildep_packages(dbname, src_pack_id):
 def sub_packages(dbname, src_pack_id):
     """
     Description: Query package layer 1 installation dependency
-    :param dbname:  databases name
-    :param src_pack_id: srcpackage id
-    :return: subpack  Source package to binary package, then find the installation dependencies
+    Args:
+        dbname:  databases name
+        src_pack_id: srcpackage id
+    Returns:
+        subpack  Source package to binary package, then find the installation dependencies
      of the binary package
+    Raises:
+         AttributeError: Object does not have this property
     """
     with DBHelper(db_name=dbname) as db_name:
         subpack = {}
@@ -93,12 +109,16 @@ def sub_packages(dbname, src_pack_id):
 
 
 def get_single_package(dbname, sourcename):
-    '''
+    """
     Description: Get all packages info
-    :param dbname: Database name
-    :param sourcename: Source package name
-    :return: package info
-    '''
+    Args：
+        dbname: Database name
+        sourcename: Source package name
+    Returns：
+        package info
+    Raises:
+        AttributeError: Object does not have this property
+    """
     with DBHelper(db_name=dbname) as db_name:
         package = {}
         src_pack_obj = db_name.session.query(src_pack).filter_by(
@@ -126,11 +146,16 @@ def update_single_package(
         maintain_level):
     """
     Description: change single package management
-    :param package_name: package name
-    :param dbname: Database name
-    :param maintainer: maintainer info
-    :param maintain_level: maintain_level info
-    :return: message  success or failed
+    Args：
+        package_name: package name
+        dbname: Database name
+        maintainer: maintainer info
+        maintain_level: maintain_level info
+    Returns：
+        message  success or failed
+    Raises:
+        AttributeError: Object does not have this property
+        TypeError: Abnormal error
     """
     with DBHelper(db_name=dbname) as db_name:
         update_obj = db_name.session.query(
@@ -144,16 +169,19 @@ def update_maintaniner_info(package_name,
                             dbname,
                             maintaniner,
                             maintainlevel):
-    '''
     """
-    update separately maintaniner info
-    :param package_name: package name
-    :param dbname: Database name
-    :param maintainer: maintainer info
-    :param maintain_level: maintain_level info
-    :return: message  success or failed
+    Description: update separately maintaniner info
+    Args：
+       package_name: package name
+       dbname: Database name
+       maintainer: maintainer info
+       maintain_level: maintain_level info
+    Returns：
+       message  success or failed
+    Raises:
+       AttributeError: Object does not have this property
+       Error: Abnormal error
     """
-    '''
     with DBHelper(db_name=dbname) as db_name:
         src_pack_obj = db_name.session.query(src_pack).filter_by(
             name=package_name).first()

packageship/packageship/application/apps/package/serialize.py

+#!/usr/bin/python3
 """
-marshmallow serialize
+Description: marshmallow serialize
 """
 from marshmallow import Schema
 from marshmallow import fields
@@ -9,7 +10,7 @@ from marshmallow import validate
 
 class PackagesSchema(Schema):
     """
-    PackagesSchema serialize
+    Description: PackagesSchema serialize
     """
     dbName = fields.Str(validate=validate.Length(
         max=50), required=False, allow_none=True)
@@ -17,7 +18,7 @@ class PackagesSchema(Schema):
 
 class GetpackSchema(Schema):
     """
-    GetpackSchema serialize
+    Description: GetpackSchema serialize
     """
     sourceName = fields.Str(
         required=True,
@@ -32,7 +33,13 @@ class GetpackSchema(Schema):
 
 def validate_maintainlevel(maintainlevel):
     """
-    Method test
+    Description: Method test
+    Args：
+        maintainlevel: maintainlevel
+    Returns:
+        True or failure
+    Raises:
+        ValidationError: Test failed
     """
     if maintainlevel not in ['1', '2', '3', '4']:
         raise ValidationError("maintainLevel is illegal data ")
@@ -40,7 +47,7 @@ def validate_maintainlevel(maintainlevel):
 
 class PutpackSchema(Schema):
     """
-    PutpackSchema serialize
+    Description: PutpackSchema serialize
     """
     sourceName = fields.Str(
         required=True,
@@ -62,7 +69,7 @@ class PutpackSchema(Schema):
 
 class InstallDependSchema(Schema):
     """
-    InstallDependSchema
+    Description: InstallDependSchema
     """
     binaryName = fields.Str(
         required=True,
@@ -73,7 +80,7 @@ class InstallDependSchema(Schema):
 
 class BuildDependSchema(Schema):
     """
-    BuildDependSchema serialize
+    Description: BuildDependSchema serialize
     """
     sourceName = fields.Str(
         required=True,
@@ -84,7 +91,13 @@ class BuildDependSchema(Schema):
 
 def validate_withsubpack(withsubpack):
     """
-    Method test
+    Description: Method test
+    Args：
+        withsubpack: withsubpack
+    Returns:
+        True or failure
+    Raises:
+        ValidationError: Test failed
     """
     if withsubpack not in ['0', '1']:
         raise ValidationError("withSubpack is illegal data ")
@@ -92,7 +105,7 @@ def validate_withsubpack(withsubpack):
 
 class BeDependSchema(Schema):
     """
-    BeDependSchema serialize
+    Description: BeDependSchema serialize
     """
     packagename = fields.Str(
         required=True,
@@ -111,7 +124,7 @@ class BeDependSchema(Schema):
 
 def validate_selfbuild(selfbuild):
     """
-    Method test
+    Description: Method test
     """
     if selfbuild not in ['0', '1']:
         raise ValidationError("selfbuild is illegal data ")
@@ -119,7 +132,7 @@ def validate_selfbuild(selfbuild):
 
 def validate_packtype(packtype):
     """
-    Method test
+    Description: Method test
     """
     if packtype not in ['source', 'binary']:
         raise ValidationError("packtype is illegal data ")
@@ -127,7 +140,7 @@ def validate_packtype(packtype):
 
 class SelfDependSchema(Schema):
     """
-    SelfDependSchema serialize
+    Description: SelfDependSchema serialize
     """
     packagename = fields.Str(
         required=True,
@@ -145,7 +158,7 @@ class SelfDependSchema(Schema):
 
 class DeletedbSchema(Schema):
     """
-    DeletedbSchema serialize
+    Description: DeletedbSchema serialize
     """
     dbName = fields.Str(
         required=True,
@@ -155,17 +168,21 @@ class DeletedbSchema(Schema):
 
 
 def have_err_db_name(db_list, db_priority):
-    '''
-    @param:db_list db list of inputs
-    @param:db_priority default list
-    return:If any element in db_list  is no longer in db_priority, return false
-    '''
+    """
+    Description: have error database name method
+    Args:
+        db_list: db_list db list of inputs
+        db_priority: db_priority default list
+    Returns:
+        If any element in db_list  is no longer in db_priority, return false
+    Raises:
+    """
     return any(filter(lambda db_name: db_name not in db_priority, db_list))
 
 
 class InitSystemSchema(Schema):
     """
-    InitSystemSchema serialize
+    Description: InitSystemSchema serialize
     """
     configfile = fields.Str(
         validate=validate.Length(

packageship/packageship/application/apps/package/url.py

+#!/usr/bin/python3
 """
-    url set
+Description: url set
 """
 from . import view
 

packageship/packageship/application/models/package.py

 #!/usr/bin/python3
-'''
-Database entity model mapping
-'''
+"""
+Description: Database entity model mapping
+"""
 from sqlalchemy import Column, Integer, String, ForeignKey
 from sqlalchemy.orm import relationship
 from packageship.libs.dbutils.sqlalchemy_helper import DBHelper
 
 
 class src_pack(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-    functional description:Source package model
+    """
+    Description: functional description:Source package model
     modify record:
-    '''
+    """
 
     __tablename__ = 'src_pack'
 
@@ -33,10 +33,10 @@ class src_pack(DBHelper.BASE):  # pylint: disable=C0103,R0903
 
 
 class bin_pack(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-    functional description:Binary package data
+    """
+    Description: functional description:Binary package data
     modify record:
-    '''
+    """
     __tablename__ = 'bin_pack'
 
     id = Column(Integer, primary_key=True)

packageship/packageship/application/models/temporarydb.py

 #!/usr/bin/python3
-'''
-Database entity model mapping
-'''
+"""
+Description: Database entity model mapping
+"""
 from sqlalchemy import Column, Integer, String
 from packageship.libs.dbutils.sqlalchemy_helper import DBHelper
 
 
 class src_package(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-        Temporary source package model
-    '''
+    """
+    Description: Temporary source package model
+    """
 
     __tablename__ = 'src_package'
 
@@ -27,9 +27,9 @@ class src_package(DBHelper.BASE):  # pylint: disable=C0103,R0903
 
 
 class bin_package(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-        Temporary binary package model
-    '''
+    """
+    Description: Temporary binary package model
+    """
     __tablename__ = 'bin_package'
 
     pkgKey = Column(Integer, primary_key=True)
@@ -48,9 +48,9 @@ class bin_package(DBHelper.BASE):  # pylint: disable=C0103,R0903
 
 
 class src_requires(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-        Temporary source package depends on package model
-    '''
+    """
+    Description: Temporary source package depends on package model
+    """
     __tablename__ = 'src_requires'
 
     id = Column(Integer, primary_key=True)
@@ -61,9 +61,9 @@ class src_requires(DBHelper.BASE):  # pylint: disable=C0103,R0903
 
 
 class bin_requiresment(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-        Dependency package model for temporary binary packages
-    '''
+    """
+    Description: Dependency package model for temporary binary packages
+    """
     __tablename__ = 'bin_requiresment'
 
     id = Column(Integer, primary_key=True)
@@ -74,9 +74,9 @@ class bin_requiresment(DBHelper.BASE):  # pylint: disable=C0103,R0903
 
 
 class bin_provides(DBHelper.BASE):  # pylint: disable=C0103,R0903
-    '''
-        Provided package model for temporary binary packages
-    '''
+    """
+    Description: Provided package model for temporary binary packages
+    """
     __tablename__ = 'bin_provides'
 
     id = Column(Integer, primary_key=True)

packageship/packageship/application/settings.py

 #!/usr/bin/python3
-'''
-    Basic configuration of flask framework
-'''
+"""
+Description: Basic configuration of flask framework
+"""
 import random
 from packageship.libs.configutils.readconfig import ReadConfig
 
 
 class Config():
-    '''
-        Configuration items in a formal environment
-    '''
+    """
+    Description: Configuration items in a formal environment
+    Attributes:
+        _read_config: read config
+        _set_config_val: Set the value of the configuration item
+    """
     SECRET_KEY = None
 
     DEBUG = False
@@ -24,31 +27,34 @@ class Config():
 
     @classmethod
     def _random_secret_key(cls, random_len=32):
-        '''
-            Generate random strings
-        '''
+        """
+        Description: Generate random strings
+        """
         cls.SECRET_KEY = ''.join(
             [random.choice('abcdefghijklmnopqrstuvwxyz!@#$%^&*()') for index in range(random_len)])
 
     @classmethod
     def _set_debug(cls, debug):
-        '''
-            Set the debugging mode
-        '''
+        """
+        Description: Set the debugging mode
+        """
         if debug == 'true':
             cls.DEBUG = True
 
     @classmethod
     def _set_log_level(cls, log_level):
-        '''
-            Set the log level
-        '''
+        """
+        Description: Set the log level
+        """
         cls.LOG_LEVEL = log_level
 
     def set_config_val(self):
-        '''
-            Set the value of the configuration item
-        '''
+        """
+        Description: Set the value of the configuration item
+        Args:
+        Returns:
+        Raises:
+        """
         Config._random_secret_key()
 
         debug = self._read_config.get_system('debug')

packageship/packageship/manage.py

 #!/usr/bin/python3
-'''
-    Entry for project initialization and service startupc
-'''
+"""
+Description: Entry for project initialization and service startupc
+"""
 import os
 from packageship.libs.exception import Error
 try:
@@ -28,6 +28,9 @@ else:
 
 @app.before_request
 def before_request():
+    """
+    Description: Global request interception
+    """
     if not identity_verification():
         return 'No right to perform operation'
 

packageship/packageship/selfpkg.py

 #!/usr/bin/python3
-'''
-    Entry for project initialization and service startupc
-'''
+"""
+Description: Entry for project initialization and service startupc
+"""
 import os
 from flask_script import Manager
 from packageship.libs.exception import Error
@@ -29,6 +29,9 @@ else:
 
 @app.before_request
 def before_request():
+    """
+    Description: Global request interception
+    """
     if not identity_verification():
         return 'No right to perform operation'
 

packageship/packageship/system_config.py

 #!/usr/bin/python3
-'''
-System-level file configuration, mainly configure
+"""
+Description：System-level file configuration, mainly configure
 the address of the operating environment, commonly used variables, etc.
-'''
+"""
 
 import os
 import sys