Re: [Buildroot] [PATCH 2/4] utils/check-package: support a file-state instance for library types

[Ricardo Martincoski <ricardo.martincoski@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 2952 bytes --]

Hello,

Sorry the long delay.

On Sat, Apr 29, 2023 at 03:12 PM, James Knight wrote:

> from: James Knight <james.d.knight@live.com>
> date: Sat, Apr 29 02:12 PM -04:00 2023
> to: buildroot@buildroot.org
> cc: James Knight <james.d.knight@live.com>, Ricardo Martincoski <ricardo.martincoski@datacom.com.br>
> subject: [Buildroot] [PATCH 2/4] utils/check-package: support a file-state instance for library types
> 
> The following adds support to the checkpackage library to have a
> file-specific state instance that can be changed across multiple
> `check_line` calls. This allows a given library type to provide hints
> across different lines (if needed).

This is a great idea.

> 
> This is in preparation for a future commit to provide support for
> linter suppression that is configured in the files being processed.
> 
> Signed-off-by: James Knight <james.d.knight@live.com>
> ---
>  utils/check-package                 |  8 ++++++++
>  utils/checkpackagelib/base.py       |  2 +-
>  utils/checkpackagelib/lib.py        | 10 +++++-----
>  utils/checkpackagelib/lib_config.py | 10 +++++-----
>  utils/checkpackagelib/lib_hash.py   |  6 +++---
>  utils/checkpackagelib/lib_mk.py     | 22 +++++++++++-----------
>  utils/checkpackagelib/lib_patch.py  |  6 +++---
>  utils/checkpackagelib/lib_sysv.py   |  4 ++--
>  utils/checkpackagelib/test_util.py  |  4 ++--
>  9 files changed, 40 insertions(+), 32 deletions(-)
> 
> diff --git a/utils/check-package b/utils/check-package
> index db3a00b524bc2c2aa663d3621c94fb11a6db7cb3..890420fe6992d49ad7d50f311007689e35ab7681 100755
> --- a/utils/check-package
> +++ b/utils/check-package
> @@ -220,6 +220,12 @@ def check_file_using_lib(fname):
>          print("{}: would run: {}".format(fname, functions_to_run))
>          return nwarnings, nlines
>  
> +    # Check if there is a state tracker we can create for this library type,
> +    # and then forward to each `check_line` invoked
> +    fstate = None
> +    if hasattr(lib, 'State') and inspect.isclass(lib.State):
> +        fstate = lib.State()
> +
>      objects = [[c[0], c[1](fname, flags.manual_url)] for c in internal_functions]
>  
>      for name, cf in objects:
> @@ -231,6 +237,8 @@ def check_file_using_lib(fname):
>      lastline = ""
>      with open(fname, "r", errors="surrogateescape") as f:
>          for lineno, text in enumerate(f):
> +            if fstate:
> +                fstate.process(text)
>              nlines += 1
>              for name, cf in objects:
>                  if cf.disable.search(lastline):

This line of code (that is already there) made me wonder if we can
factor-out this code to the base class and add the new implementation
there.
The advantages of this alternative are:
 - avoid adding code to the main check-package script that currently is
   not covered by unit tests
 - avoid the need to change all users of the base class

I will send shortly a patch with this factor-out.

Regards,
Ricardo

[-- Attachment #2: Type: text/plain, Size: 150 bytes --]

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot