Code style changes to please Pylint

Author: martinjoiner

.github/workflows/pylint.yml

@@ -7,17 +7,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.10", "3.11"]
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install pylint
-    - name: Analysing the code with pylint
-      run: |
-        pylint $(git ls-files '*.py')
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install pylint
+      - name: Copy example words file
+        run: cp words.example.py words.py
+      - name: Analysing the code with pylint
+        run: |
+          pylint $(git ls-files '*.py')

cli_light.py

@@ -2,6 +2,8 @@
 
 
 class CLILight(Light):
+  """ Simulates a light on the command line """
+
   block = ' ' * 42
 
   def on(self):

flash.py

@@ -1,19 +1,20 @@
 #!/usr/bin/env python
 
+import time
+
 from cli_light import CLILight
 from morsecode import MorseCodeFlasher
-import time
 from word_of_the_day import send_todays_word
 
 
 # The length of a beat in seconds
-a_beat = .15
+A_BEAT = .15
 
-delay_between_letters = 8 * a_beat
+DELAY_BETWEEN_LETTERS = 8 * A_BEAT
 
 light = CLILight()
-code_flasher = MorseCodeFlasher(a_beat, delay_between_letters, light)
+code_flasher = MorseCodeFlasher(A_BEAT, DELAY_BETWEEN_LETTERS, light)
 
-time.sleep(2 * a_beat)
+time.sleep(2 * A_BEAT)
 
 send_todays_word(code_flasher)

light.py

@@ -1,10 +1,14 @@
-# Abstract class to be extended for different interfaces
 class Light:
+  """ Abstract class to be extended for different interfaces """
+
   def on(self):
+    """ Puts the light into whatever state represents on """
     print("On")
 
   def off(self):
+    """ Puts the light into whatever state represents off """
     print("Off")
 
   def finish(self):
-    return  
+    """ Clean-up any leftover state from on() or off() """
+    return

listen.py

@@ -24,40 +24,43 @@
 wiringpi.pinMode(PIN_BUTTON, wiringpi.GPIO.INPUT)
 
 # The length of a beat in seconds
-a_beat = .15
+A_BEAT = .15
 
-delay_between_letters = 8 * a_beat
+DELAY_BETWEEN_LETTERS = 8 * A_BEAT
 
 
 class PiBorgLight(Light):
+  """ Controls the illumination of PiBorg LED """
 
   # Set the colour channel intensity (1 is fully on, 0 is off)
   red = 1
   green = 1
   blue = 1
 
+
   def on(self):
-    # Turn the LedBorg on
+    """ Turn the LedBorg on """
     wiringpi.digitalWrite(PIN_RED, self.red)
     wiringpi.digitalWrite(PIN_GREEN, self.green)
     wiringpi.digitalWrite(PIN_BLUE, self.blue)
 
 
   def off(self):
-    # Turn the LedBorg off
+    """ Turn the LedBorg off """
     wiringpi.digitalWrite(PIN_RED, 0)
     wiringpi.digitalWrite(PIN_GREEN, 0)
     wiringpi.digitalWrite(PIN_BLUE, 0)
 
 
 light = PiBorgLight()
-code_flasher = MorseCodeFlasher(a_beat, delay_between_letters, light)
+code_flasher = MorseCodeFlasher(A_BEAT, DELAY_BETWEEN_LETTERS, light)
 
 
 def record_push():
-  url = 'http://morse.pelmo.uk/ping/index.php'  
+  """ Makes a HTTP Request to record the event of a button push """
+  url = 'http://morse.pelmo.uk/ping/index.php'
   headers = {
-    'Content-Type': 'multipart/form-data',      
+    'Content-Type': 'multipart/form-data',
     'User-Agent': 'Morse code RaspberryPi'
   }
   try:
@@ -66,9 +69,10 @@ def record_push():
       data={ 'ping': 1 },
       timeout=3
     )
-    print('Response code: ' + str(response.status_code)) 
-  except:
-    print('Post failed')
+    print('Response code: ' + str(response.status_code))
+  except requests.exceptions.HTTPError as errh:
+    print("HTTP Error")
+    print(errh.args[0])
 
 
 code_flasher.flash_code('-.-')
@@ -78,6 +82,6 @@ def record_push():
 while True: # Run forever
   if wiringpi.digitalRead(PIN_BUTTON):
     print("Button was pushed!")
-    time.sleep(2 * a_beat)
+    time.sleep(2 * A_BEAT)
     send_todays_word(code_flasher)
     # record_push()

morsecode.py

@@ -35,7 +35,16 @@
 }
 
 
+class InvalidMorseCodeException(Exception):
+  """ Exception for if a string does not consist of just dots and dashes """
+
+
 class MorseCodeFlasher:
+  """
+  Initialises with an instance of class Light and uses it to flash morse code messages
+  when flash_word or flash_code are called
+  """
+
   def __init__(self, a_beat: float, delay_between_letters: float, light: Light):
     self.a_beat = a_beat
     self.delay_between_letters = delay_between_letters
@@ -50,19 +59,17 @@ def __light_up_for(self, seconds: float):
 
   def __dash(self):
     self.__light_up_for(6 * self.a_beat)
-    
+
 
   def __dot(self):
     self.__light_up_for(self.a_beat)
 
 
   def flash_code(self, code: str):
-    """
-    :param code: A string containing only full-stops (dots) and hypens (dashes)
-    """
+    """ :param code: A string containing only full-stops (dots) and hypens (dashes) """
 
     if re.match(r'[^.-]+', code) is not None:
-      raise Exception
+      raise InvalidMorseCodeException
 
     for flash in code:
       if flash == '.':
@@ -72,10 +79,11 @@ def flash_code(self, code: str):
 
 
   def flash_word(self, word: str):
+    """ Translates each letter of the word into morse code and passes to flash_code() """
     for letter in word:
       code = alphabet[letter]
       self.flash_code(code)
       time.sleep(self.delay_between_letters)
-    
+
     self.light.finish()
     print('Done')

pyproject.toml

@@ -0,0 +1,3 @@
+[tool.pylint."MESSAGES CONTROL"]
+disable = ["missing-module-docstring"]
+indent-string='  '

requirements.txt

@@ -0,0 +1,2 @@
+requests
+wiringpi

word_of_the_day.py

@@ -1,11 +1,11 @@
 from datetime import date
 
-from light import Light
 from morsecode import MorseCodeFlasher
 from words import words
 
 
 def send_todays_word(code_flasher: MorseCodeFlasher):
+  """ Establishes what today's word of the day is and sends to code_flasher """
   today = date.today()
   month = today.strftime("%b")
   day = int(today.strftime("%d"))