From e1bdae2069a95285d15531f0d9d02b248503828f Mon Sep 17 00:00:00 2001 From: "Jorge A. Duarte" Date: Sun, 15 Oct 2017 13:23:57 -0500 Subject: [PATCH] Made documentation changes as requested, according to PEP-257. --- amodem/alsa.py | 8 +++++--- amodem/async.py | 4 ++-- amodem/audio.py | 5 ++--- amodem/calib.py | 4 ++-- amodem/common.py | 8 +++++--- amodem/config.py | 2 ++ amodem/detect.py | 4 ++-- amodem/dsp.py | 4 ++-- amodem/equalizer.py | 4 ++-- scripts/plot.py | 11 +++++++---- scripts/record.py | 8 +++++--- scripts/resample.py | 7 ++++--- 12 files changed, 40 insertions(+), 29 deletions(-) diff --git a/amodem/alsa.py b/amodem/alsa.py index 2fec92a..da9141e 100644 --- a/amodem/alsa.py +++ b/amodem/alsa.py @@ -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): diff --git a/amodem/async.py b/amodem/async.py index 688dc20..13b2577 100644 --- a/amodem/async.py +++ b/amodem/async.py @@ -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): diff --git a/amodem/audio.py b/amodem/audio.py index f2d4a8c..8fffd02 100644 --- a/amodem/audio.py +++ b/amodem/audio.py @@ -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) diff --git a/amodem/calib.py b/amodem/calib.py index 01ee34b..6963775 100644 --- a/amodem/calib.py +++ b/amodem/calib.py @@ -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): diff --git a/amodem/common.py b/amodem/common.py index ef863c6..9243cd0 100644 --- a/amodem/common.py +++ b/amodem/common.py @@ -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): diff --git a/amodem/config.py b/amodem/config.py index abe57e2..a6881f2 100644 --- a/amodem/config.py +++ b/amodem/config.py @@ -1,3 +1,5 @@ +"""Configuration class.""" + import numpy as np diff --git a/amodem/detect.py b/amodem/detect.py index 069365e..c61ec8e 100644 --- a/amodem/detect.py +++ b/amodem/detect.py @@ -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): diff --git a/amodem/dsp.py b/amodem/dsp.py index eab59db..7027625 100644 --- a/amodem/dsp.py +++ b/amodem/dsp.py @@ -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): diff --git a/amodem/equalizer.py b/amodem/equalizer.py index 2ec481e..243bc41 100644 --- a/amodem/equalizer.py +++ b/amodem/equalizer.py @@ -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): diff --git a/scripts/plot.py b/scripts/plot.py index 3546856..fa79227 100755 --- a/scripts/plot.py +++ b/scripts/plot.py @@ -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) diff --git a/scripts/record.py b/scripts/record.py index 8126f40..9366330 100755 --- a/scripts/record.py +++ b/scripts/record.py @@ -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() diff --git a/scripts/resample.py b/scripts/resample.py index 5e33a30..9ae3873 100755 --- a/scripts/resample.py +++ b/scripts/resample.py @@ -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()