完成app模块的log添加

CaiquanLiu · CaiquanLiu · commit a222e07fee6a · 2017-10-18T12:18:35.000+08:00
diff --git a/app/framework/mic.py b/app/framework/mic.py
@@ -1,15 +1,23 @@
 # -*- coding: utf-8 -*-
-
-
 import pyaudio
 import logging
 
 logger = logging.getLogger(__file__)
 
 
 class Audio(object):
+    '''
+    录音类(基于pyaudio)
+    '''
 
     def __init__(self, rate=16000, frames_size=None, channels=None, device_index=None):
+        '''
+        录音类初始化
+        :param rate:采样率
+        :param frames_size:数据帧大小
+        :param channels:通道数
+        :param device_index:录音设备id
+        '''
         self.sample_rate = rate
         self.frames_size = frames_size if frames_size else rate / 100
         self.channels = channels if channels else 1
@@ -39,30 +47,56 @@ def __init__(self, rate=16000, frames_size=None, channels=None, device_index=Non
             channels=self.channels,
             rate=int(self.sample_rate),
             frames_per_buffer=int(self.frames_size),
-            stream_callback=self._callback,
+            stream_callback=self.__callback,
             input=True
         )
 
         self.sinks = []
 
-    def _callback(self, in_data, frame_count, time_info, status):
-        for sink in self.sinks:
-            sink.put(in_data)
-        return None, pyaudio.paContinue
-
     def start(self):
+        '''
+        开始录音
+        :return:
+        '''
         self.stream.start_stream()
 
     def stop(self):
+        '''
+        结束录音
+        :return:
+        '''
         self.stream.stop_stream()
 
     def link(self, sink):
+        '''
+        绑定录音接收实体
+        :param sink: 录音接收实体
+        :return:
+        '''
         if hasattr(sink, 'put') and callable(sink.put):
             self.sinks.append(sink)
         else:
             raise ValueError('Not implement put() method')
 
     def unlink(self, sink):
+        '''
+        录音实体解除绑定
+        :param sink: 录音接收实体
+        :return:
+        '''
         self.sinks.remove(sink)
 
+    def __callback(self, in_data, frame_count, time_info, status):
+        '''
+        录音数据(pmc)回调
+        :param in_data:录音数据
+        :param frame_count:
+        :param time_info:
+        :param status:
+        :return:
+        '''
+        for sink in self.sinks:
+            sink.put(in_data)
+        return None, pyaudio.paContinue
+
 
diff --git a/app/framework/player.py b/app/framework/player.py
@@ -1,17 +1,22 @@
 # -*- coding: utf-8 -*-
 
-"""Player using gstreamer."""
+"""
+基于GStreamer的播放模块
+"""
 
-import time
 import gi
+
 gi.require_version('Gst', '1.0')
 from gi.repository import Gst
 
-
 Gst.init(None)
 
 
 class Player(object):
+    '''
+    播放器实现类
+    '''
+
     def __init__(self):
         self.player = Gst.ElementFactory.make("playbin", "player")
 
@@ -21,21 +26,43 @@ def __init__(self):
         # self.bus.connect('sync-message::eos', self.on_eos)
 
     def play(self, uri):
+        '''
+        播放
+        :param uri:播放资源地址
+        :return:
+        '''
         self.player.set_state(Gst.State.NULL)
         self.player.set_property('uri', uri)
         self.player.set_state(Gst.State.PLAYING)
 
     def stop(self):
+        '''
+        停止
+        :return:
+        '''
         self.player.set_state(Gst.State.NULL)
 
     def pause(self):
+        '''
+        暂停
+        :return:
+        '''
         self.player.set_state(Gst.State.PAUSED)
 
     def resume(self):
+        '''
+        回复播放
+        :return:
+        '''
         self.player.set_state(Gst.State.PLAYING)
 
-    # name: {eos, ...}
     def add_callback(self, name, callback):
+        '''
+        播放状态回调
+        :param name: {eos, ...}
+        :param callback: 回调函数
+        :return:
+        '''
         if not callable(callback):
             return
 
@@ -46,12 +73,20 @@ def on_message(bus, message):
 
     @property
     def duration(self):
+        '''
+        播放时长
+        :return:
+        '''
         success, duration = self.player.query_duration(Gst.Format.TIME)
         if success:
             return int(duration / Gst.MSECOND)
 
     @property
     def position(self):
+        '''
+        播放位置
+        :return:
+        '''
         success, position = self.player.query_position(Gst.Format.TIME)
         if not success:
             position = 0
@@ -60,6 +95,10 @@ def position(self):
 
     @property
     def state(self):
+        '''
+        播放状态
+        :return:
+        '''
         # GST_STATE_VOID_PENDING        no pending state.
         # GST_STATE_NULL                the NULL state or initial state of an element.
         # GST_STATE_READY               the element is ready to go to PAUSED.
@@ -68,4 +107,3 @@ def state(self):
         # GST_STATE_PLAYING             the element is PLAYING, the GstClock is running and the data is flowing.
         _, state, _ = self.player.get_state(Gst.SECOND)
         return 'FINISHED' if state != Gst.State.PLAYING else 'PLAYING'
-
