Made documentation changes as requested, according to PEP-257.

This commit is contained in:
Jorge A. Duarte
2017-10-15 13:23:57 -05:00
parent 1ff777d226
commit e1bdae2069
12 changed files with 40 additions and 29 deletions

View File

@@ -1,11 +1,13 @@
"""Code which adds Linux ALSA support for interfaces,
recording and playing.
"""
import subprocess
import logging
log = logging.getLogger(__name__)
"""Code which adds Linux ALSA support for interfaces,
recording and playing.
"""
class Interface(object):

View File

@@ -1,11 +1,11 @@
"""Asynchronous Reading capabilities for amodem."""
import threading
import six # since `Queue` module was renamed to `queue` (in Python 3)
import logging
log = logging.getLogger()
"""Asynchronous Reading capabilities for amodem.
"""
class AsyncReader(object):
def __init__(self, stream, bufsize):

View File

@@ -1,12 +1,11 @@
"""Audio capabilities for amodem."""
import ctypes
import logging
import time
log = logging.getLogger(__name__)
"""Audio capabilities for amodem.
"""
class Interface(object):
def __init__(self, config, debug=False):
self.debug = bool(debug)

View File

@@ -1,3 +1,5 @@
"""Calibration capabilities for amodem."""
from . import common
from . import dsp
from . import sampling
@@ -10,8 +12,6 @@ import subprocess
log = logging.getLogger(__name__)
"""Calibration capabilities for amodem.
"""
def volume_controller(cmd):
def controller(level):

View File

@@ -1,5 +1,7 @@
''' Common package functionality.
'''
""" Common package functionality.
Commom utilities and procedures for amodem.
"""
import itertools
import numpy as np
@@ -9,7 +11,7 @@ log = logging.getLogger(__name__)
scaling = 32000.0 # out of 2**15
"""Commom utilities and procedures for amodem.
"""
"""
def load(fileobj):

View File

@@ -1,3 +1,5 @@
"""Configuration class."""
import numpy as np

View File

@@ -1,3 +1,5 @@
"""Signal detection capabilities for amodem."""
from . import dsp
from . import equalizer
from . import common
@@ -9,8 +11,6 @@ import collections
log = logging.getLogger(__name__)
"""Signal detection capabilities for amodem.
"""
class Detector(object):

View File

@@ -1,9 +1,9 @@
"""Digital Signal Processing capabilities for amodem."""
import numpy as np
from . import common
"""Digital Signal Processing capabilities for amodem.
"""
class FIR(object):
def __init__(self, h):

View File

@@ -1,3 +1,5 @@
"""Audio equalizing capabilities for amodem."""
from . import dsp
from . import sampling
from . import levinson
@@ -5,8 +7,6 @@ from . import levinson
import numpy as np
import itertools
"""Audio equalizing capabilities for amodem.
"""
class Equalizer(object):

View File

@@ -1,14 +1,17 @@
#!/usr/bin/env python
"""Script that exposes pylab's spectogram plotting
capabilities to the command line. It implements this
for amodem.config Configurations.
"""
import pylab
import numpy as np
from amodem import common
from amodem.config import Configuration
import sys
"""Script that exposes pylab's spectogram plotting
capabilities to the command line. It implements this
for amodem.config Configurations.
"""
def spectrogram(t, x, Fs, NFFT=256):
ax1 = pylab.subplot(211)

View File

@@ -1,11 +1,13 @@
#!/usr/bin/env python
"""Script that records audio through an interface
and stores it into an amodem.config Configuration.
"""
import argparse
from amodem import audio
from amodem.config import Configuration
"""Script that records audio through an interface
and stores it into an amodem.config Configuration.
"""
def run(args):
config = Configuration()

View File

@@ -1,13 +1,14 @@
#!/usr/bin/env python
from amodem.sampling import resample
import argparse
import sys
"""Script that exposes the amodem.resample() function
to the command line, taking parameters via standard
inputs and returning results via standard outputs.
"""
from amodem.sampling import resample
import argparse
import sys
def main():
p = argparse.ArgumentParser()