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') --indent-string='  ' --disable=missing-module-docstring

cli_light.py

@@ -2,6 +2,10 @@
 
 
 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

@@ -7,4 +7,4 @@ def off(self):
     print("Off")
 
   def finish(self):
-    return  
+    return

listen.py

@@ -24,12 +24,15 @@
 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
@@ -51,13 +54,13 @@ def off(self):
 
 
 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'  
+  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,7 +69,7 @@ def record_push():
       data={ 'ping': 1 },
       timeout=3
     )
-    print('Response code: ' + str(response.status_code)) 
+    print('Response code: ' + str(response.status_code))
   except:
     print('Post failed')
 
@@ -78,6 +81,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

@@ -50,7 +50,7 @@ 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)

requirements.txt

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

word_of_the_day.py

@@ -1,11 +1,14 @@
 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"))