DAY3代码注释

此文为Python学习的注释，代码来源于廖老师，方便自己以后查询修改学习，本人还是小白，如果有不对，请多指教

  

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

__author__ = 'Michael Liao'

import asyncio, logging

import aiomysql

def log(sql, args=()):
    logging.info('SQL: %s' % sql)

async def create_pool(loop, **kw):
    logging.info('create database connection pool...')
    global __pool
    __pool = await aiomysql.create_pool(
        host=kw.get('host', 'localhost'),
        port=kw.get('port', 3306),
        user=kw['user'],
        password=kw['password'],
        db=kw['db'],
        charset=kw.get('charset', 'utf8'),
        autocommit=kw.get('autocommit', True),
        maxsize=kw.get('maxsize', 10),
        minsize=kw.get('minsize', 1),
        loop=loop
    )

async def select(sql, args, size=None):
    log(sql, args)
    global __pool #这里应该是为了申明__pool与开头声明的为同一个变量
    '''
    with...as 方法说明：
      此方法主要针对于需要close的一些操作，比如操作file，cursor，pool ，最后都需要close，所以as后面参数就代表操作close的那个变量。
      例如：
           with (file) as f:
            file.read
           
    '''
    async with __pool.get() as conn:
        '''
        1.先创建一个光标cursor（dict型）
        2.执行sql语句，execute
        3.将结果抓取出来
        '''
        async with conn.cursor(aiomysql.DictCursor) as cur:#aiomysql.dictcursor 为返回的数据是一个dict。 A cursor which returns results as a dictionary. 
            await cur.execute(sql.replace('?', '%s'), args or ())
            if size:
                rs = await cur.fetchmany(size)#获取size数量的结果
            else:
                rs = await cur.fetchall()#获取全部结果
        logging.info('rows returned: %s' % len(rs))
        return rs

async def execute(sql, args, autocommit=True):
    log(sql)
    async with __pool.get() as conn:
        if not autocommit:
            await conn.begin()
        try:
            async with conn.cursor(aiomysql.DictCursor) as cur:
                await cur.execute(sql.replace('?', '%s'), args)#这里注意，cur.execute()为aiomysql中的方法。
                affected = cur.rowcount
            if not autocommit:#自动提交有什么特殊含义？

                await conn.commit()
        except BaseException as e:
            if not autocommit:
                await conn.rollback()
            raise
        return affected #return的数据有什么用？
        

def create_args_string(num):
    L = []
    for n in range(num):
        L.append('?')
    return ', '.join(L)

class Field(object):

    def __init__(self, name, column_type, primary_key, default):
        self.name = name
        self.column_type = column_type
        self.primary_key = primary_key
        self.default = default

    def __str__(self):
        return '<%s, %s:%s>' % (self.__class__.__name__, self.column_type, self.name)

class StringField(Field):

    def __init__(self, name=None, primary_key=False, default=None, ddl='varchar(100)'): #ddl为数据库中字段的长度。
        super().__init__(name, ddl, primary_key, default)

class BooleanField(Field):

    def __init__(self, name=None, default=False):
        super().__init__(name, 'boolean', False, default)

class IntegerField(Field):

    def __init__(self, name=None, primary_key=False, default=0):
        super().__init__(name, 'bigint', primary_key, default)

class FloatField(Field):

    def __init__(self, name=None, primary_key=False, default=0.0):
        super().__init__(name, 'real', primary_key, default)

class TextField(Field):

    def __init__(self, name=None, default=None):
        super().__init__(name, 'text', False, default)

#当一个USER对象建立后，里面的每一个对象都代表一个字段，每个字段有四个属性，我们通过不同的方式，筛选出主键、非主键、等各种属性。
class ModelMetaclass(type):
   
    def __new__(cls, name, bases, attrs):
        if name=='Model':
            return type.__new__(cls, name, bases, attrs)#cls应该是指对象本身 ,name指的是类的名称，bases指该类继承的父类集合，attrs指的是类中定义的方法和变量
        #'__table__'为类中变量，会在类中定义
        tableName = attrs.get('__table__', None) or name# 上面的type中的四个属性，就组成了一个类的所有条件，类名，父类集合，变量和函数。
        logging.info('found model: %s (table: %s)' % (name, tableName))
        mappings = dict()
        fields = []
        primaryKey = None
        for k, v in attrs.items():#python 中应该是对items（）函数进行了分割处理，形成了一个map对应关系，K值就是字段名称，V值是字段对象。
            if isinstance(v, Field):
                logging.info('  found mapping: %s ==> %s' % (k, v))
                mappings[k] = v
                if v.primary_key:
                    # 找到主键:
                    if primaryKey:#主键必须唯一，第一个参数进来后如果是主键，他的primary_key就是none，接下来primary_key会被赋值
                                  #下一个V如果还是主键，这时候primary_key是有值的，就会报错了
                        raise StandardError('Duplicate primary key for field: %s' % k)
                    primaryKey = k
                else:
                    fields.append(k) #记录出不是主键的字段
        if not primaryKey:
            raise StandardError('Primary key not found.')
        for k in mappings.keys():
            attrs.pop(k) #删除掉表中的字段属性
        escaped_fields = list(map(lambda f: '`%s`' % f, fields))
        attrs['__mappings__'] = mappings # 保存属性和列的映射关系
        attrs['__table__'] = tableName
        attrs['__primary_key__'] = primaryKey # 主键属性名
        attrs['__fields__'] = fields # 除主键外的属性名
        attrs['__select__'] = 'select `%s`, %s from `%s`' % (primaryKey, ', '.join(escaped_fields), tableName)
        attrs['__insert__'] = 'insert into `%s` (%s, `%s`) values (%s)' % (tableName, ', '.join(escaped_fields), primaryKey, create_args_string(len(escaped_fields) + 1))
        #insert这个sql语句中最后补充的，？？？是什么意思？
        attrs['__update__'] = 'update `%s` set %s where `%s`=?' % (tableName, ', '.join(map(lambda f: '`%s`=?' % (mappings.get(f).name or f), fields)), primaryKey)
        attrs['__delete__'] = 'delete from `%s` where `%s`=?' % (tableName, primaryKey)
        return type.__new__(cls, name, bases, attrs)#元类创建了新的类后，里面的参数都会变成attrs中的参数，创建对象后，可以直接用参数。

class Model(dict, metaclass=ModelMetaclass):

    def __init__(self, **kw):
        super(Model, self).__init__(**kw)

    def __getattr__(self, key):
        try:
            return self[key]
        except KeyError:
            raise AttributeError(r"'Model' object has no attribute '%s'" % key)

    def __setattr__(self, key, value):
        self[key] = value

    def getValue(self, key):
        return getattr(self, key, None) #getattr方法为内建函数，里面的参数self和key，实际上等于self.key，NONE是指默认值，当self.key没有值时。
    #在创建的数据中，没有表中的字段，这种字段系统会进行判断，如果有这个。
    def getValueOrDefault(self, key): #这个函数理解还是不深刻
        value = getattr(self, key, None)
        if value is None:
            field = self.__mappings__[key]#为什么要去mapping中去找？
            if field.default is not None:
                value = field.default() if callable(field.default) else field.default
                logging.debug('using default value for %s: %s' % (key, str(value)))
                setattr(self, key, value)
        return value

    @classmethod #用于不创建对象，直接可以调用方法。
    async def findAll(cls, where=None, args=None, **kw):
        ' find objects by where clause. '
        sql = [cls.__select__]
        if where:
            sql.append('where')
            sql.append(where) #如果有where条件，直接在sql语句后面加入
        if args is None:
            args = []
        orderBy = kw.get('orderBy', None)
        if orderBy:
            sql.append('order by')
            sql.append(orderBy)
        limit = kw.get('limit', None)
        if limit is not None:
            sql.append('limit')
            if isinstance(limit, int):#limit有两个参数，表示选择返回值的范围，第一个参数表示返回值的开始位置，第二个参数表示从开始位置往后的个数。
                sql.append('?')
                args.append(limit)
            elif isinstance(limit, tuple) and len(limit) == 2: #查询limit是否是两个属性
                sql.append('?, ?')
                args.extend(limit)#extend只接受一个列表为参数，并且提取出该参数（列表）中的参数
            else:
                raise ValueError('Invalid limit value: %s' % str(limit))
        rs = await select(' '.join(sql), args)#select函数从哪里来的？重点，目前未找到说明
        return [cls(**r) for r in rs]#查询出结果

    @classmethod
    async def findNumber(cls, selectField, where=None, args=None):
        ' find number by select and where. '
        sql = ['select %s _num_ from `%s`' % (selectField, cls.__table__)] #_num_ 应该是个mysql的语法
        if where:
            sql.append('where')
            sql.append(where)
        rs = await select(' '.join(sql), args, 1)
        if len(rs) == 0:
            return None
        return rs[0]['_num_']

    @classmethod
    async def find(cls, pk):
        ' find object by primary key. '
        rs = await select('%s where `%s`=?' % (cls.__select__, cls.__primary_key__), [pk], 1)#这里的__select__是被赋值了的？【PK】是被赋值给？的
        if len(rs) == 0:
            return None
        return cls(**rs[0])

    async def save(self):
        args = list(map(self.getValueOrDefault, self.__fields__))#这里直接利用__fields__，应该是前面的元类重新生成的USER类的变量
        args.append(self.getValueOrDefault(self.__primary_key__))
        rows = await execute(self.__insert__, args)
        if rows != 1:
            logging.warn('failed to insert record: affected rows: %s' % rows)

    async def update(self):
        args = list(map(self.getValue, self.__fields__))
        args.append(self.getValue(self.__primary_key__))
        rows = await execute(self.__update__, args)
        if rows != 1:
            logging.warn('failed to update by primary key: affected rows: %s' % rows)

    async def remove(self):
        args = [self.getValue(self.__primary_key__)]
        rows = await execute(self.__delete__, args)
        if rows != 1:
            logging.warn('failed to remove by primary key: affected rows: %s' % rows)