Merge branch 'develop' into pcan-bit-timing

Author: christiansandberg

.appveyor.yml

@@ -14,14 +14,11 @@ install:
   # Prepend Python installation and scripts (e.g. pytest) to PATH
   - set PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%
 
-  # We need to install the python-can library itself including the dependencies
-  - "python -m pip install .[test,neovi]"
+  # Install tox
+  - "pip install tox"
 
 build: off
 
 test_script:
   # run tests
-  - "pytest"
-
-  # uplad coverage reports
-  - "codecov -X gcov"
+  - "tox -e appveyor"

.codecov.yml

@@ -1,7 +1,7 @@
 # Validate with curl --data-binary @.codecov.yml https://codecov.io/validate
 codecov:
   archive:
-    uploads: no
+    uploads: yes
 
 coverage:
   precision: 2

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.6, 3.7, 3.8]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+        pip install -r requirements-lint.txt
+    - name: Test with pytest via tox
+      run: |
+        tox -e gh
+    - name: Code Format Check with Black
+      run: |
+        black --check --verbose .

.gitignore

@@ -1,5 +1,8 @@
 test/__tempdir__/
 .pytest_cache/
+.mypy_cache/
+.dmypy.json
+dmypy.json
 
 # -------------------------
 # below: https://github.com/github/gitignore/blob/da00310ccba9de9a988cc973ef5238ad2c1460e9/Python.gitignore

.mergify.yml

@@ -0,0 +1,28 @@
+pull_request_rules:
+  - name: Automatic merge passing PR on up to date branch with approving CR
+    conditions:
+      - "#approved-reviews-by>=1"
+      - "#review-requested=0"
+      - "#changes-requested-reviews-by=0"
+      - "#commented-reviews-by=0"
+      - "status-success=continuous-integration/travis-ci/pr"
+      - "label!=work-in-progress"
+    actions:
+      merge:
+        method: merge
+        strict: smart+fasttrack
+  - name: Request Brian to review changes on core api.
+    conditions:
+      - "-files~=^can/interfaces/$"
+      - "-closed"
+      - "author!=hardbyte"
+    actions:
+      request_reviews:
+        users:
+          - hardbyte
+
+  - name: delete head branch after merge
+    conditions:
+      - merged
+    actions:
+      delete_head_branch: {}

.pylintrc

@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to be ignored. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to be ignored. The
 # regex matches against base names, not paths.
 ignore-patterns=
 

.pylintrc-wip

@@ -5,11 +5,11 @@
 # run arbitrary code.
 extension-pkg-whitelist=
 
-# Add files or directories to the blacklist. They should be base names, not
+# Add files or directories to be ignored. They should be base names, not
 # paths.
 ignore=CVS
 
-# Add files or directories matching the regex patterns to the blacklist. The
+# Add files or directories matching the regex patterns to to be ignored. The
 # regex matches against base names, not paths.
 ignore-patterns=
 

.travis.yml

@@ -11,7 +11,7 @@ python:
   # CPython; only 3.6 is supported
   - "3.6"
   - "3.7"
-  - 3.8-dev
+  - "3.8"
   - nightly
   # PyPy:
   - pypy3
@@ -21,25 +21,19 @@ env:
 
 install:
   - if [[ "$TEST_SOCKETCAN" ]]; then sudo bash test/open_vcan.sh ; fi
-  - travis_retry pip install .[test]
+  - python setup.py install
 
 script:
   - |
+    # install tox
+    pip install tox
     # Run the tests
-    python setup.py test
-    # preserve the error code
-    RETURN_CODE=$?
-    # Upload the coverage to codecov.io
-    codecov -X gcov
-    # set error code
-    (exit $RETURN_CODE);
-
+    tox -e travis
 
 jobs:
   allow_failures:
     # we allow all dev & nightly builds to fail, since these python versions might
     # still be very unstable
-    - python: 3.8-dev
     - python: nightly
 
   include:
@@ -80,12 +74,43 @@ jobs:
       before_install:
         - travis_retry pip install -r requirements-lint.txt
       script:
+        # -------------
+        # pylint checking:
         # Slowly enable all pylint warnings by adding addressed classes of
         # warnings to the .pylintrc-wip file to prevent them from being
         # re-introduced
-        - pylint --rcfile=.pylintrc-wip can/
-        # mypy checking
-        - mypy --python-version=3.7 --ignore-missing-imports --no-implicit-optional can/bit_timing.py can/broadcastmanager.py can/bus.py can/interface.py can/listener.py can/logger.py can/message.py can/notifier.py can/player.py can/thread_safe_bus.py can/util.py
+        # check the entire main codebase
+        - pylint --rcfile=.pylintrc-wip can/**.py
+        - pylint --rcfile=.pylintrc setup.py
+        - pylint --rcfile=.pylintrc doc.conf
+        # check the scripts folder
+        - find scripts -type f -name "*.py" | xargs pylint --rcfile=.pylintrc
+        # check the examples
+        - find examples -type f -name "*.py" | xargs pylint --rcfile=.pylintrc-wip
+        # -------------
+        # mypy checking:
+        - mypy
+          --python-version=3.7
+          --ignore-missing-imports
+          --no-implicit-optional
+          can/bit_timing.py
+          can/broadcastmanager.py
+          can/bus.py
+          can/interface.py
+          can/interfaces/slcan.py
+          can/interfaces/socketcan/**.py
+          can/interfaces/virtual.py
+          can/listener.py
+          can/logger.py
+          can/message.py
+          can/notifier.py
+          can/player.py
+          can/thread_safe_bus.py
+          can/typechecking.py
+          can/util.py
+          can/io/**.py
+          scripts/**.py
+          examples/**.py
     - stage: linter
       name: "Formatting Checks"
       python: "3.7"

CHANGELOG.txt

@@ -1,3 +1,61 @@
+Version 4.0.0
+====
+
+(In development)
+
+
+Version 3.3.4
+====
+
+Last call for Python2 support.
+
+* #850 Fix socket.error is a deprecated alias of OSError used on Python versions lower than 3.3.
+
+Version 3.3.3
+====
+
+Backported fixes from 4.x development branch which targets Python 3.
+
+* #798 Backport caching msg.data value in neovi interface.
+* #796 Fix Vector CANlib treatment of empty app name.
+* #771 Handle empty CSV file.
+* #741 ASCII reader can now handle FD frames.
+* #740 Exclude test packages from distribution.
+* #713 RTR crash fix in canutils log reader parsing RTR frames.
+* #701 Skip J1939 messages in ASC Reader.
+* #690 Exposes a configuration option to allow the CAN message player to send error frames
+  (and sets the default to not send error frames).
+* #638 Fixes the semantics provided by periodic tasks in SocketCAN interface.
+* #628 Avoid padding CAN_FD_MESSAGE_64 objects to 4 bytes.
+* #617 Fixes the broken CANalyst-II interface.
+* #605 Socketcan BCM status fix.
+
+
+Version 3.3.2
+====
+
+Minor bug fix release addressing issue in PCAN RTR.
+
+Version 3.3.1
+====
+
+Minor fix to setup.py to only require pytest-runner when necessary.
+
+Version 3.3.0
+====
+
+* Adding CAN FD 64 frame support to blf reader
+* Updates to installation instructions
+* Clean up bits generator in PCAN interface #588
+* Minor fix to use latest tools when building wheels on travis.
+
+Version 3.2.1
+====
+
+* CAN FD 64 frame support to blf reader
+* Minor fix to use latest tools when building wheels on travis.
+* Updates links in documentation.
+
 Version 3.2.0
 ====
 

README.rst

@@ -1,12 +1,26 @@
 python-can
 ==========
 
-|release| |docs| |build_travis| |build_appveyor| |coverage| |downloads| |formatter|
+|release| |downloads| |downloads_monthly| |formatter|
+
+|docs| |build_travis| |build_appveyor| |coverage|
 
 .. |release| image:: https://img.shields.io/pypi/v/python-can.svg
    :target: https://pypi.python.org/pypi/python-can/
    :alt: Latest Version on PyPi
 
+.. |downloads| image:: https://pepy.tech/badge/python-can
+   :target: https://pepy.tech/project/python-can
+   :alt: Downloads on PePy
+
+.. |downloads_monthly| image:: https://pepy.tech/badge/python-can/month
+   :target: https://pepy.tech/project/python-can/month
+   :alt: Monthly downloads on PePy
+
+.. |formatter| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/python/black
+   :alt: This project uses the black formatter.
+
 .. |docs| image:: https://readthedocs.org/projects/python-can/badge/?version=stable
    :target: https://python-can.readthedocs.io/en/stable/
    :alt: Documentation
@@ -23,13 +37,9 @@ python-can
    :target: https://codecov.io/gh/hardbyte/python-can/branch/develop
    :alt: Test coverage reports on Codecov.io
 
-.. |downloads| image:: https://pepy.tech/badge/python-can
-   :target: https://pepy.tech/project/python-can
-   :alt: Downloads on PePy
-
-.. |formatter| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-   :target: https://github.com/python/black
-   :alt: This project uses the black formatter.
+.. image:: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/hardbyte/python-can&style=flat
+   :target: https://mergify.io
+   :alt: Mergify Status
 
 The **C**\ ontroller **A**\ rea **N**\ etwork is a bus standard designed
 to allow microcontrollers and devices to communicate with each other. It
@@ -44,13 +54,13 @@ messages on a can bus.
 The library currently supports Python 3.6+ as well as PyPy 3 and runs
 on Mac, Linux and Windows.
 
-=============================  ===========
-Library Version                Python
------------------------------  -----------
-  2.x                          2.6+, 3.4+
-  3.x                          2.7+, 3.5+
-  4.x *(currently on devlop)*  3.6+
-=============================  ===========
+==============================  ===========
+Library Version                 Python
+------------------------------  -----------
+  2.x                           2.6+, 3.4+
+  3.x                           2.7+, 3.5+
+  4.x *(currently on develop)*  3.6+
+==============================  ===========
 
 
 Features
@@ -89,7 +99,7 @@ Example usage
 
     # iterate over received messages
     for msg in bus:
-        print("{X}: {}".format(msg.arbitration_id, msg.data))
+        print("{:X}: {}".format(msg.arbitration_id, msg.data))
 
     # or use an asynchronous notifier
     notifier = can.Notifier(bus, [can.Logger("recorded.log"), can.Printer()])