add tweaks for pylint; detect (some) generic linux systems; rename class

Main wrapper class is now `Detector`, which is more noun-y than verb-y.

Added GENERIC_X86 and GENERIC_LINUX_PC to chip and board, respectively.

Made pylint happier.

Author: brennen

adafruit_platformdetect/__init__.py

@@ -28,7 +28,11 @@
 from adafruit_platformdetect.board import Board
 from adafruit_platformdetect.chip import Chip
 
-class PlatformDetector:
+# Various methods here may retain state in future, so tell pylint not to worry
+# that they don't use self right now:
+# pylint: disable=no-self-use
+class Detector:
+    """Wrap various platform detection functions."""
 
     def __init__(self):
         self.board = Board(self)
@@ -59,8 +63,8 @@ def get_armbian_release_field(self, field):
         field_value = None
         pattern = r'^' + field + r'=(.*)'
         try:
-            with open("/etc/armbian-release", 'r') as f:
-                armbian = f.read().split('\n')
+            with open("/etc/armbian-release", 'r') as release_file:
+                armbian = release_file.read().split('\n')
                 for line in armbian:
                     match = re.search(pattern, line)
                     if match:

adafruit_platformdetect/board.py

@@ -1,8 +1,8 @@
+"""Detect boards."""
 import adafruit_platformdetect.chip as ap_chip
-import platform
-import sys
-import re
 
+# Allow for aligned constant definitions:
+# pylint: disable=bad-whitespace
 BEAGLEBONE                  = 'BEAGLEBONE'
 BEAGLEBONE_BLACK            = 'BEAGLEBONE_BLACK'
 BEAGLEBONE_BLUE             = 'BEAGLEBONE_BLUE'
@@ -21,6 +21,7 @@
 
 FEATHER_HUZZAH              = "FEATHER_HUZZAH"
 FEATHER_M0_EXPRESS          = "FEATHER_M0_EXPRESS"
+GENERIC_LINUX_PC            = "GENERIC_LINUX_PC"
 PYBOARD                     = "PYBOARD"
 NODEMCU                     = "NODEMCU"
 ORANGE_PI_PC                = "ORANGE_PI_PC"
@@ -37,8 +38,8 @@
 RASPBERRY_PI_3B_PLUS        = "RASPBERRY_PI_3B_PLUS"
 RASPBERRY_PI_CM3            = "RASPBERRY_PI_CM3"
 RASPBERRY_PI_3A_PLUS        = "RASPBERRY_PI_3A_PLUS"
+# pylint: enable=bad-whitespace
 
-# TODO: Should this include RASPBERRY_PI_3A_PLUS or any other models?
 ANY_RASPBERRY_PI_2_OR_3 = (
     RASPBERRY_PI_2B,
     RASPBERRY_PI_3B,
@@ -96,7 +97,6 @@
     BEAGLEBONE_AIR: (
         ('A0', 'A335BNLTNAD0'),
     ),
-    # TODO: Does this differ meaningfully from the PocketBeagle?
     BEAGLEBONE_POCKETBONE: (
         ('0', 'A335BNLTBP00'),
     ),
@@ -130,32 +130,35 @@
 }
 
 class Board:
-    """
-    Attempt to detect specific boards.
-    """
+    """Attempt to detect specific boards."""
     def __init__(self, detector):
         self.detector = detector
 
+    # pylint: disable=invalid-name
     @property
     def id(self):
         """Return a unique id for the detected board, if any."""
 
         chip_id = self.detector.chip.id
+        board_id = None
 
         if chip_id == ap_chip.BCM2XXX:
-            return self._pi_id()
+            board_id = self._pi_id()
         elif chip_id == ap_chip.AM33XX:
-            return self._beaglebone_id()
+            board_id = self._beaglebone_id()
+        elif chip_id == ap_chip.GENERIC_X86:
+            board_id = GENERIC_LINUX_PC
         elif chip_id == ap_chip.SUN8I:
-            return self._armbian_id()
+            board_id = self._armbian_id()
         elif chip_id == ap_chip.ESP8266:
-            return FEATHER_HUZZAH
+            board_id = FEATHER_HUZZAH
         elif chip_id == ap_chip.SAMD21:
-            return FEATHER_M0_EXPRESS
+            board_id = FEATHER_M0_EXPRESS
         elif chip_id == ap_chip.STM32:
-            return PYBOARD
+            board_id = PYBOARD
 
-        return None
+        return board_id
+    # pylint: enable=invalid-name
 
     def _pi_id(self):
         """Try to detect id of a Raspberry Pi."""
@@ -178,6 +181,7 @@ def _pi_rev_code(self):
             return None
         return self.detector.get_cpuinfo_field('Revision')
 
+    # pylint: disable=no-self-use
     def _beaglebone_id(self):
         """Try to detect id of a Beaglebone."""
         try:
@@ -190,14 +194,14 @@ def _beaglebone_id(self):
             return None
 
         id_string = eeprom_bytes[4:].decode("ascii")
-        for model, ids in _BEAGLEBONE_BOARD_IDS.items():
-            for id in ids:
-                if id_string == id[1]:
+        for model, bb_ids in _BEAGLEBONE_BOARD_IDS.items():
+            for bb_id in bb_ids:
+                if id_string == bb_id[1]:
                     return model
 
         return None
+    # pylint: enable=no-self-use
 
-    @property
     def _armbian_id(self):
         """Check whether the current board is an OrangePi PC."""
         board_value = self.detector.get_armbian_release_field('BOARD')
@@ -212,6 +216,7 @@ def any_raspberry_pi(self):
 
     @property
     def any_raspberry_pi_2_or_3(self):
+        """Check whether the current board is any Raspberry Pi 2 or 3."""
         return self.id in ANY_RASPBERRY_PI_2_OR_3
 
     def __getattr__(self, attr):

adafruit_platformdetect/chip.py

@@ -1,3 +1,4 @@
+"""Attempt detection of current chip / CPU."""
 import sys
 
 AM33XX = "AM33XX"
@@ -6,39 +7,47 @@
 SAMD21 = "SAMD21"
 STM32 = "STM32"
 SUN8I = "SUN8I"
+GENERIC_X86 = "GENERIC_X86"
 
 class Chip:
     """Attempt detection of current chip / CPU."""
     def __init__(self, detector):
         self.detector = detector
 
     @property
+    # pylint: disable=invalid-name
     def id(self):
+        """Return a unique id for the detected chip, if any."""
         platform = sys.platform
         if platform == "linux":
             return self._linux_id()
-        elif platform == "esp8266":
+        if platform == "esp8266":
             return ESP8266
-        elif platform == "samd21":
+        if platform == "samd21":
             return SAMD21
-        elif platform == "pyboard":
+        if platform == "pyboard":
             return STM32
-        else:
-            return None
+        return None
+    # pylint: enable=invalid-name
 
     def _linux_id(self):
         """Attempt to detect the CPU on a computer running the Linux kernel."""
-        id = None
+        linux_id = None
 
         hardware = self.detector.get_cpuinfo_field("Hardware")
-        if hardware in ('BCM2708', 'BCM2708', 'BCM2835'):
-            id = BCM2XXX
+
+        if hardware is None:
+            vendor_id = self.detector.get_cpuinfo_field("vendor_id")
+            if vendor_id in ("GenuineIntel", "AuthenticAMD"):
+                linux_id = GENERIC_X86
+        elif hardware in ("BCM2708", "BCM2708", "BCM2835"):
+            linux_id = BCM2XXX
         elif "AM33XX" in hardware:
-            id = AM33XX
+            linux_id = AM33XX
         elif "sun8i" in hardware:
-            id = SUN8I
+            linux_id = SUN8I
 
-        return id
+        return linux_id
 
     def __getattr__(self, attr):
         """

bin/detect.py

@@ -2,18 +2,16 @@
 
 import adafruit_platformdetect
 
-detector = adafruit_platformdetect.PlatformDetector()
+detector = adafruit_platformdetect.Detector()
 
 print("Chip id: ", detector.chip.id)
 
 print("Board id: ", detector.board.id)
 
 print("Is this a Pi 3B+?", detector.board.RASPBERRY_PI_3B_PLUS)
 print("Is this a BBB?", detector.board.BEAGLEBONE_BLACK)
+print("Is this an Orange Pi PC?", detector.board.ORANGE_PI_PC)
+print("Is this a generic Linux PC?", detector.board.GENERIC_LINUX_PC)
 
 if detector.board.any_raspberry_pi:
     print("Raspberry Pi detected.")
-    print("Revision code: ", detector.board._pi_rev_code())
-
-if detector.board.BEAGLEBONE_BLACK:
-    print("BBB detected")

setup.py

@@ -1,12 +1,11 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 # Note: To use the 'upload' functionality of this file, you must:
 #   $ pip install twine
 
 import io
 import os
-import sys
 
 from setuptools import setup, find_packages