CI: fixing the files to be complient with pre-commit hooks

Author: suren-gabrielyan-espressif

.flake8

@@ -136,6 +136,5 @@ show_source = True
 
 statistics = True
 
-per-file-ignores =
-    # Sphinx conf.py files use star imports to setup config variables
-        docs/conf_common.py: F405
+exclude =
+        components/asio/docs/conf_common.py

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Formating according pre-commit hooks
+3e1c3cc647b6f6d4da20b3ab979879f60229bfee

.github/workflows/target-test.yml

@@ -8,7 +8,7 @@ jobs:
       matrix:
         idf_ver: ["latest", "release-v4.1", "release-v4.2", "release-v4.3", "release-v4.4"]
         example: ["pppos_client", "modem_console", "ap_to_pppos", "simple_cmux_client"]
-        idf_target: ["esp32"]        
+        idf_target: ["esp32"]
         exclude:
           - idf_ver: "release-v4.1"
             example: modem_console
@@ -57,30 +57,30 @@ jobs:
           cat sdkconfig.ci.usb >> sdkconfig.defaults
           idf.py build
 
-  build_mdns: 
-    strategy: 
-      matrix: 
-        idf_ver: ["latest"] 
+  build_mdns:
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
         idf_target: ["esp32", "esp32s2", "esp32c3"]
         config: ["eth_custom_netif", "eth_def", "eth_no_ipv6", "eth_socket"]
-    runs-on: ubuntu-20.04 
-    container: espressif/idf:${{ matrix.idf_ver }} 
-    steps: 
-      - name: Checkout esp-protocols 
-        uses: actions/checkout@v3 
-        with: 
-          submodules: recursive 
-      - name: Build ${{ matrix.example }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }} for ${{ matrix.config }} 
-        env: 
-          IDF_TARGET: ${{ matrix.idf_target }} 
-        shell: bash 
+    runs-on: ubuntu-20.04
+    container: espressif/idf:${{ matrix.idf_ver }}
+    steps:
+      - name: Checkout esp-protocols
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - name: Build ${{ matrix.example }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }} for ${{ matrix.config }}
+        env:
+          IDF_TARGET: ${{ matrix.idf_target }}
+        shell: bash
         working-directory: components/mdns/examples/
-        run: | 
-          . ${IDF_PATH}/export.sh 
+        run: |
+          . ${IDF_PATH}/export.sh
           rm -rf sdkconfig sdkconfig.defaults build build_${{ matrix.config }}
-          cat sdkconfig.ci.${{ matrix.config }} >> sdkconfig.defaults  
-          idf.py set-target ${{ matrix.idf_target }}  
-          idf.py build 
+          cat sdkconfig.ci.${{ matrix.config }} >> sdkconfig.defaults
+          idf.py set-target ${{ matrix.idf_target }}
+          idf.py build
           mv build build_${{ matrix.config }}
       - name: Merge binaries with IDF-${{ matrix.idf_ver }} for ${{ matrix.config }}
         working-directory: components/mdns/examples
@@ -118,7 +118,7 @@ jobs:
       - name: Checkout esp-protocols
         uses: actions/checkout@v3
         with:
-          submodules: recursive 
+          submodules: recursive
       - name: Build ${{ matrix.example }} with IDF-${{ matrix.idf_ver }} for ${{ matrix.idf_target }}
         working-directory: components/asio/examples/${{ matrix.example }}
         env:
@@ -234,9 +234,9 @@ jobs:
           path: components/esp_websocket_client/examples/*.xml
 
   run-target-mdns:
-    strategy: 
-      matrix: 
-        idf_ver: ["latest"] 
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
         idf_target: ["esp32"]
         config: ["eth_custom_netif", "eth_def", "eth_no_ipv6", "eth_socket"]
     name: Run mDNS Example Test on target
@@ -267,7 +267,7 @@ jobs:
         run: |
             rm -rf build
             mv build_${{ matrix.config }} build
-            cat sdkconfig.ci.${{ matrix.config }} >> sdkconfig.defaults  
+            cat sdkconfig.ci.${{ matrix.config }} >> sdkconfig.defaults
             python -m pytest --log-cli-level DEBUG --junit-xml=./examples_results_${{ matrix.idf_target }}_${{ matrix.idf_ver }}_${{ matrix.config }}.xml --target=${{ matrix.idf_target }}
             rm -rf build sdkconfig.defaults
       - uses: actions/upload-artifact@v2
@@ -277,9 +277,9 @@ jobs:
           path: components/mdns/examples/*.xml
 
   run-target-asio:
-    strategy: 
-      matrix: 
-        idf_ver: ["latest"] 
+    strategy:
+      matrix:
+        idf_ver: ["latest"]
         idf_target: ["esp32"]
         example: ["asio_chat", "tcp_echo_server", "udp_echo_server", "ssl_client_server"]
     name: Run ASIO Example Test on target

.mypy.ini

@@ -0,0 +1,26 @@
+[mypy]
+
+# Specifies the Python version used to parse and check the target program
+python_version = 3.9
+
+# Disallows defining functions without type annotations or with incomplete type annotations
+# True => enforce type annotation in all function definitions
+disallow_untyped_defs = True
+
+# Shows a warning when returning a value with type Any from a function declared with a non- Any return type
+warn_return_any = True
+
+# Shows errors for missing return statements on some execution paths
+warn_no_return = True
+
+# Suppress error messages about imports that cannot be resolved
+# True => ignore all import errors
+ignore_missing_imports = True
+
+# Disallows defining functions with incomplete type annotations
+disallow_incomplete_defs = False
+
+# Directs what to do with imports when the imported module is found as a .py file and not part of the files,
+# modules and packages provided on the command line.
+# SKIP -> mypy checks only single file, not included imports
+follow_imports = skip

.pre-commit-config.yaml

@@ -20,6 +20,10 @@ repos:
     rev: v0.981
     hooks:
       - id: mypy
+        exclude: >
+           (?x)^(
+               .*.py
+           )$
   - repo: https://github.com/myint/unify
     rev: v0.5
     hooks:

ci/check_copyright_config.yaml

@@ -46,9 +46,19 @@ asio_component:
     - Apache-2.0
     - BSL-1.0
 
+slim_modem_examples:
+  include:
+    - 'examples/esp_netif/slip_custom_netif/**'
+  allowed_licenses:
+    - Apache-2.0
+    - Unlicense
+    - CC0-1.0
+
 ignore:
   perform_check: no
   include:
    - 'components/**/docs/**'
    - 'components/esp_modem/port/linux/**'
-   - 'components/asio/examples/asio_chat/main/*'
+   - 'components/asio/examples/**'
+   - 'components/mdns/**/esp_system_protocols_linux/**'
+   - 'common_components/protocol_examples_common/**'

common_components/protocol_examples_common/addr_from_stdin.c

@@ -26,7 +26,7 @@ esp_err_t get_addr_from_stdin(int port, int sock_type, int *ip_protocol, int *ad
     do {
         fgets(host_ip, HOST_IP_SIZE, stdin);
         len = strlen(host_ip);
-    } while (len<=1 && host_ip[0] == '\n');
+    } while (len <= 1 && host_ip[0] == '\n');
     host_ip[len - 1] = '\0';
 
     struct addrinfo hints, *addr_list, *cur;
@@ -36,16 +36,16 @@ esp_err_t get_addr_from_stdin(int port, int sock_type, int *ip_protocol, int *ad
     hints.ai_family = AF_UNSPEC;
     hints.ai_socktype = sock_type;
     hints.ai_protocol = IPPROTO_TCP;
-    if( getaddrinfo( host_ip, NULL, &hints, &addr_list ) != 0 ) {
+    if ( getaddrinfo( host_ip, NULL, &hints, &addr_list ) != 0 ) {
         return ESP_FAIL;
     }
-    for( cur = addr_list; cur != NULL; cur = cur->ai_next ) {
+    for ( cur = addr_list; cur != NULL; cur = cur->ai_next ) {
         memcpy(dest_addr, cur->ai_addr, sizeof(*dest_addr));
         if (cur->ai_family == AF_INET) {
             *ip_protocol = IPPROTO_IP;
             *addr_family = AF_INET;
             // add port number and return on first IPv4 match
-            ((struct sockaddr_in*)dest_addr)->sin_port = htons(port);
+            ((struct sockaddr_in *)dest_addr)->sin_port = htons(port);
             freeaddrinfo( addr_list );
             return ESP_OK;
 
@@ -55,8 +55,8 @@ esp_err_t get_addr_from_stdin(int port, int sock_type, int *ip_protocol, int *ad
             *ip_protocol = IPPROTO_IPV6;
             *addr_family = AF_INET6;
             // add port and interface number and return on first IPv6 match
-            ((struct sockaddr_in6*)dest_addr)->sin6_port = htons(port);
-            ((struct sockaddr_in6*)dest_addr)->sin6_scope_id = esp_netif_get_netif_impl_index(EXAMPLE_INTERFACE);
+            ((struct sockaddr_in6 *)dest_addr)->sin6_port = htons(port);
+            ((struct sockaddr_in6 *)dest_addr)->sin6_scope_id = esp_netif_get_netif_impl_index(EXAMPLE_INTERFACE);
             freeaddrinfo( addr_list );
             return ESP_OK;
         }

common_components/protocol_examples_common/connect.c

@@ -1,10 +1,11 @@
-/* Common functions for protocol examples, to establish Wi-Fi or Ethernet connection.
-
-   This example code is in the Public Domain (or CC0 licensed, at your option.)
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
 
-   Unless required by applicable law or agreed to in writing, this
-   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-   CONDITIONS OF ANY KIND, either express or implied.
+/*
+ *  Common functions for protocol examples, to establish Wi-Fi or Ethernet connection.
  */
 
 #include <string.h>

common_components/protocol_examples_common/include/addr_from_stdin.h

@@ -1,13 +1,14 @@
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
+
 /*  Common utilities for socket address input interface:
     The API get_addr_from_stdin() is mainly used by socket client examples which read IP address from stdin (if configured).
     This option is typically used in the CI, but could be enabled in the project configuration.
     In that case this component is used to receive a string that is evaluated and processed to output
     socket structures to open a connectio
-   This example code is in the Public Domain (or CC0 licensed, at your option.)
-
-   Unless required by applicable law or agreed to in writing, this
-   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-   CONDITIONS OF ANY KIND, either express or implied.
  */
 
 #pragma once

common_components/protocol_examples_common/include/protocol_examples_common.h

@@ -1,10 +1,11 @@
-/* Common functions for protocol examples, to establish Wi-Fi or Ethernet connection.
-
-   This example code is in the Public Domain (or CC0 licensed, at your option.)
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
 
-   Unless required by applicable law or agreed to in writing, this
-   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-   CONDITIONS OF ANY KIND, either express or implied.
+/*
+ * Common functions for protocol examples, to establish Wi-Fi or Ethernet connection.
  */
 
 #pragma once

common_components/protocol_examples_common/stdin_out.c

@@ -1,10 +1,11 @@
-/* Common functions for protocol examples, to configure stdin and stdout.
-
-   This example code is in the Public Domain (or CC0 licensed, at your option.)
+/*
+ * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
 
-   Unless required by applicable law or agreed to in writing, this
-   software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-   CONDITIONS OF ANY KIND, either express or implied.
+/*
+ * Common functions for protocol examples, to configure stdin and stdout.
  */
 
 #include "protocol_examples_common.h"
@@ -19,7 +20,7 @@ esp_err_t example_configure_stdin_stdout(void)
     setvbuf(stdin, NULL, _IONBF, 0);
     /* Install UART driver for interrupt-driven reads and writes */
     ESP_ERROR_CHECK( uart_driver_install( (uart_port_t)CONFIG_ESP_CONSOLE_UART_NUM,
-            256, 0, 0, NULL, 0) );
+                                          256, 0, 0, NULL, 0) );
     /* Tell VFS to use UART driver */
     esp_vfs_dev_uart_use_driver(CONFIG_ESP_CONSOLE_UART_NUM);
     esp_vfs_dev_uart_port_set_rx_line_endings(CONFIG_ESP_CONSOLE_UART_NUM, ESP_LINE_ENDINGS_CR);

components/asio/docs/conf_common.py

@@ -1,10 +1,11 @@
 from esp_docs.conf_docs import *  # noqa: F403,F401
 
-extensions += ['sphinx_copybutton',
-               # Needed as a trigger for running doxygen
-               'esp_docs.esp_extensions.dummy_build_system',
-               'esp_docs.esp_extensions.run_doxygen',
-               ]
+extensions += [
+    'sphinx_copybutton',
+    # Needed as a trigger for running doxygen
+    'esp_docs.esp_extensions.dummy_build_system',
+    'esp_docs.esp_extensions.run_doxygen',
+]
 
 # link roles config
 github_repo = 'espressif/esp-protocols'
@@ -14,7 +15,7 @@
 html_context['github_repo'] = 'esp-protocols'
 
 # Extra options required by sphinx_idf_theme
-project_slug = 'esp-idf' # >=5.0
+project_slug = 'esp-idf'  # >=5.0
 versions_url = 'https://github.com/espressif/esp-protocols/docs/docs_versions.js'
 
 idf_targets = ['esp32']

components/asio/docs/generate_docs

@@ -13,7 +13,7 @@ window.onload =(function() {
     mySpan.value = 'latest';
     mySpan.setAttribute('disabled', true);
     myAnchor.parentNode.replaceChild(mySpan, myAnchor);
- 
+
     var myAnchor = document.getElementById('target-select');
     var mySpan = document.createElement('input');
     mySpan.setAttribute('type', 'text');
@@ -24,4 +24,3 @@ window.onload =(function() {
 
 })();
 </script>" >> html/index.html
-

components/asio/docs/zh_CN/index.rst

@@ -1 +1 @@
-.. include:: ../../../en/api-reference/protocols/asio.rst
+.. include:: ../../../en/api-reference/protocols/asio.rst

components/asio/examples/asio_chat/main/asio_chat.cpp

@@ -53,14 +53,15 @@ void start_client(void)
 #ifdef CONFIG_EXAMPLE_CHAT_SERVER
     std::lock_guard<std::mutex> guard(server_ready);
 #endif
-    std::thread t([&io_context]() { try {
-                                        io_context.run();
-                                  } catch (const std::exception &e) {
-                                        ESP_LOGE(TAG, "Exception occured during client thread execution %s", e.what());
-                                  }
-                                    catch (...) {
-                                         ESP_LOGE(TAG, "Unknown exception");
-                                   }});
+    std::thread t([&io_context]() {
+        try {
+            io_context.run();
+        } catch (const std::exception &e) {
+            ESP_LOGE(TAG, "Exception occured during client thread execution %s", e.what());
+        } catch (...) {
+            ESP_LOGE(TAG, "Unknown exception");
+        }
+    });
     do {
         ESP_LOGI(TAG, "CLIENT: Waiting for input");
         get_string(line, sizeof(line));
@@ -95,14 +96,14 @@ extern "C" void app_main(void)
         asio::io_context io_context;
         chat_server server(io_context, tcp::endpoint(tcp::v4(), std::atoi(CONFIG_EXAMPLE_CHAT_SERVER_BIND_PORT)));
         std::thread t =  std::thread([&io_context]() { // Chat server starting here
-                                     try {
-                                           io_context.run();
-                                     } catch (const std::exception &e) {
-                                           ESP_LOGE(TAG, "Exception occured during server thread execution %s", e.what());
-                                     }
-                                       catch (...) {
-                                           ESP_LOGE(TAG, "Unknown exception");
-                                     }});;
+            try {
+                io_context.run();
+            } catch (const std::exception &e) {
+                ESP_LOGE(TAG, "Exception occured during server thread execution %s", e.what());
+            } catch (...) {
+                ESP_LOGE(TAG, "Unknown exception");
+            }
+        });;
 #endif
 #ifdef CONFIG_EXAMPLE_CHAT_CLIENT
         start_client();